HandledMouseEventArgs

.NET Framework クラス ライブラリ リファレンス

HandledMouseEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

カスタム コントロールで、MouseWheel イベントが親コンテナに送信されないようにします。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Class HandledMouseEventArgs
    Inherits MouseEventArgs

Visual Basic (使用法)

Dim instance As HandledMouseEventArgs

C#

public class HandledMouseEventArgs : MouseEventArgs

C++

public ref class HandledMouseEventArgs : public
 MouseEventArgs

J#

public class HandledMouseEventArgs extends
 MouseEventArgs

JScript

public class HandledMouseEventArgs extends
 MouseEventArgs

解説

HandledMouseEventArgs は主に、カスタム コントロールでマウス ホイール イベントを独自に処理し、直接の親コンテナからは、マウス ホイール イベントが見えないようにしたい場合に使用します。カスタム コントロールで MouseWheel イベントが処理されていた場合、HandledMouseEventArgs が MouseEventHandler によって直接親コンテナに渡されることはありません。MouseEventHandler では、あくまで MouseEventArgs が使用されます。MouseWheel の発生をキャンセルするには、HandledMouseEventArgs にキャストする必要があります。

使用例

マウス ホイール イベントがカスタム コントロールで処理済みであるとして指定する方法を次のコード例に示します。

Visual Basic

Public Class MouseWheelControl
    Sub New()
        ' Add initialization code for the control here. 
    End Sub

    Protected Sub MouseWheelControl_MouseWheel(ByVal
 sender As Object, ByVal
 e As MouseEventArgs) Handles Me.MouseWheel
        Dim Hme As HandledMouseEventArgs =
 e
        Hme.Handled = True
        ' Perform custom mouse wheel action here. 
    End Sub
End Class

継承階層

System.Object
   System.EventArgs
     System.Windows.Forms.MouseEventArgs
      System.Windows.Forms.HandledMouseEventArgs
         System.Windows.Forms.DataGridViewColumnDividerDoubleClickEventArgs
         System.Windows.Forms.DataGridViewRowDividerDoubleClickEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
HandledMouseEventArgs メンバ
System.Windows.Forms 名前空間

HandledMouseEventArgs コンストラクタ (MouseButtons, Int32, Int32, Int32, Int32)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定したマウス ボタン、マウス ボタンのクリック回数、水平方向および垂直方向の画面座標、およびマウス ポインタの位置の変更に従って、HandledMouseEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    button As MouseButtons, _
    clicks As Integer, _
    x As Integer, _
    y As Integer, _
    delta As Integer _
)

Visual Basic (使用法)

Dim button As MouseButtons
Dim clicks As Integer
Dim x As Integer
Dim y As Integer
Dim delta As Integer

Dim instance As New HandledMouseEventArgs(button,
 clicks, x, y, delta)

C#

public HandledMouseEventArgs (
    MouseButtons button,
    int clicks,
    int x,
    int y,
    int delta
)

C++

public:
HandledMouseEventArgs (
    MouseButtons button, 
    int clicks, 
    int x, 
    int y, 
    int delta
)

J#

public HandledMouseEventArgs (
    MouseButtons button, 
    int clicks, 
    int x, 
    int y, 
    int delta
)

JScript

public function HandledMouseEventArgs (
    button : MouseButtons, 
    clicks : int, 
    x : int, 
    y : int, 
    delta : int
)

パラメータ

button

押されたマウス ボタンを示す MouseButtons 値の 1 つ。

clicks

マウス ボタンが押された回数。

x

マウスがクリックされた位置の x 座標 (ピクセル単位)。

y

マウスがクリックされた位置の y 座標 (ピクセル単位)。

delta

マウス ホイールの回転回数を表す符合付きの数値。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
HandledMouseEventArgs クラス
HandledMouseEventArgs メンバ
System.Windows.Forms 名前空間

HandledMouseEventArgs コンストラクタ (MouseButtons, Int32, Int32, Int32, Int32, Boolean)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定したマウス ボタン、マウス ボタンのクリック回数、水平方向および垂直方向の画面座標、マウス ポインタの位置の変更、およびイベントが処理されるかどうかを示す値に従って、HandledMouseEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    button As MouseButtons, _
    clicks As Integer, _
    x As Integer, _
    y As Integer, _
    delta As Integer, _
    defaultHandledValue As Boolean _
)

Visual Basic (使用法)

Dim button As MouseButtons
Dim clicks As Integer
Dim x As Integer
Dim y As Integer
Dim delta As Integer
Dim defaultHandledValue As Boolean

Dim instance As New HandledMouseEventArgs(button,
 clicks, x, y, delta, defaultHandledValue)

C#

public HandledMouseEventArgs (
    MouseButtons button,
    int clicks,
    int x,
    int y,
    int delta,
    bool defaultHandledValue
)

C++

public:
HandledMouseEventArgs (
    MouseButtons button, 
    int clicks, 
    int x, 
    int y, 
    int delta, 
    bool defaultHandledValue
)

J#

public HandledMouseEventArgs (
    MouseButtons button, 
    int clicks, 
    int x, 
    int y, 
    int delta, 
    boolean defaultHandledValue
)

JScript

public function HandledMouseEventArgs (
    button : MouseButtons, 
    clicks : int, 
    x : int, 
    y : int, 
    delta : int, 
    defaultHandledValue : boolean
)

パラメータ

button

押されたマウス ボタンを示す MouseButtons 値の 1 つ。

clicks

マウス ボタンが押された回数。

x

マウスがクリックされた位置の x 座標 (ピクセル単位)。

y

マウスがクリックされた位置の y 座標 (ピクセル単位)。

delta

マウス ホイールの回転回数を表す符合付きの数値。

defaultHandledValue

イベントが処理された場合は true。それ以外の場合は false。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
HandledMouseEventArgs クラス
HandledMouseEventArgs メンバ
System.Windows.Forms 名前空間

HandledMouseEventArgs コンストラクタ

HandledMouseEventArgs クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
HandledMouseEventArgs (MouseButtons, Int32, Int32, Int32, Int32)	指定したマウス ボタン、マウス ボタンのクリック回数、水平方向および垂直方向の画面座標、およびマウス ポインタの位置の変更に従って、HandledMouseEventArgs クラスの新しいインスタンスを初期化します。
HandledMouseEventArgs (MouseButtons, Int32, Int32, Int32, Int32, Boolean)	指定したマウス ボタン、マウス ボタンのクリック回数、水平方向および垂直方向の画面座標、マウス ポインタの位置の変更、およびイベントが処理されるかどうかを示す値に従って、HandledMouseEventArgs クラスの新しいインスタンスを初期化します。

参照

関連項目

HandledMouseEventArgs クラス
HandledMouseEventArgs メンバ
System.Windows.Forms 名前空間

HandledMouseEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Button	マウスのどのボタンが押されたかを示す値を取得します。 ( MouseEventArgs から継承されます。)
	Clicks	マウス ボタンが押されて離された回数を取得します。 ( MouseEventArgs から継承されます。)
	Delta	マウス ホイールの回転回数を表す符合付きの数値を取得します。マウス ホイールのノッチ 1 つ分が 1 移動量に相当します。 ( MouseEventArgs から継承されます。)
	Handled	このイベントをコントロールの親コンテナに送るかどうかを取得または設定します。
	Location	マウス イベント生成時のマウスの位置を取得します。 ( MouseEventArgs から継承されます。)
	X	マウス イベント生成時のマウスの x 座標を取得します。 ( MouseEventArgs から継承されます。)
	Y	マウス イベント生成時のマウスの y 座標を取得します。 ( MouseEventArgs から継承されます。)

参照

関連項目

HandledMouseEventArgs クラス
System.Windows.Forms 名前空間

HandledMouseEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

HandledMouseEventArgs クラス
System.Windows.Forms 名前空間

HandledMouseEventArgs メンバ

カスタム コントロールで、MouseWheel イベントが親コンテナに送信されないようにします。

HandledMouseEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	HandledMouseEventArgs	オーバーロードされます。 HandledMouseEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Button	マウスのどのボタンが押されたかを示す値を取得します。(MouseEventArgs から継承されます。)
	Clicks	マウス ボタンが押されて離された回数を取得します。(MouseEventArgs から継承されます。)
	Delta	マウス ホイールの回転回数を表す符合付きの数値を取得します。マウス ホイールのノッチ 1 つ分が 1 移動量に相当します。(MouseEventArgs から継承されます。)
	Handled	このイベントをコントロールの親コンテナに送るかどうかを取得または設定します。
	Location	マウス イベント生成時のマウスの位置を取得します。(MouseEventArgs から継承されます。)
	X	マウス イベント生成時のマウスの x 座標を取得します。(MouseEventArgs から継承されます。)
	Y	マウス イベント生成時のマウスの y 座標を取得します。(MouseEventArgs から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

HandledMouseEventArgs クラス
System.Windows.Forms 名前空間