ScrollControl メソッド (UltraControlBase)

呼び出し側がアンマネージコードを呼び出すセキュリティ許可を持っている場合、ネイティブのWindowsのScvrollWindowEx apiを呼び出します。そうでない場合、このメソッドはコントロールを無効化するだけです。

シンタックス

Visual Basic

'宣言
 
Protected Function ScrollControl( _
   ByVal xAmount As Integer, _
   ByVal yAmount As Integer, _
   ByVal scrollRect As Rectangle, _
   ByVal clipRect As Rectangle, _
   ByRef updateRect As Rectangle, _
   ByVal eraseBackground As Boolean, _
   ByVal invalidate As Boolean, _
   ByVal scrollChildren As Boolean, _
   ByVal smoothScrollAmount As Short _
) As Integer

C#

protected int ScrollControl( 
   int xAmount,
   int yAmount,
   Rectangle scrollRect,
   Rectangle clipRect,
   ref Rectangle updateRect,
   bool eraseBackground,
   bool invalidate,
   bool scrollChildren,
   short smoothScrollAmount
)

パラメータ

xAmount

左から右にスクロールする量。

yAmount

上下にスクロールする量。

scrollRect

スクロールされるクライアント領域の部分

clipRect

クリッピング四角形内のデバイスビットのみが影響を受けます。四角形の外側から内側にスクロールされるビットが描画されます。四角形の内側から外側にスクロールされるビットは描画されません。

updateRect

スクローリングによって無効化される四角形の領域を取得します。

eraseBackground

無効化フラグがTrueに指定されたときにWM_ERASEBKGNDメッセージをウィンドウに送ることによって、新たに無効化された領域を消去します。

invalidate

スクロールした後で、提供された領域を無効化します。

scrollChildren

scrollRectパラメーターを交差するすべての子ウィンドウをスクロールします。xAmountおよびyAmountパラメーターによって指定されたピクセル数だけ子ウィンドウをスクロールします。システムは、子ウィンドウが移動しなくても、scrollRectを交差するすべての子ウィンドウにWM_MOVEメッセージを送ります。

smoothScrollAmount

0よりも大きい場合、スムーズなスクローリングを使用してスクロールします。量はミリ秒単位です。

戻り値の型

関数が成功すると、戻り値は、SIMPLEREGION (長方形の無効化された領域) では2、COMPLEXREGION (長方形ではない無効化された領域、重複する長方形) では2、NULLREGION (無効化された領域がない) では1になります。関数が失敗すると、戻り値は0です。