RoutedEventArgs.Handled RoutedEventArgs.Handled RoutedEventArgs.Handled RoutedEventArgs.Handled Property


ルーティング イベントがルートをたどる際のイベント処理の現在の状態を示す値を取得または設定します。Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.

 property bool Handled { bool get(); void set(bool value); };
[get: System.Security.SecurityCritical]
[set: System.Security.SecurityCritical]
public bool Handled { get; set; }
member this.Handled : bool with get, set
Public Property Handled As Boolean


設定する場合に設定trueそれ以外の処理済みとしてマークする場合は、イベントfalseします。If setting, set to true if the event is to be marked handled; otherwise false. 場合は、この値を読み取るtrueクラス ハンドラーまたはルート上いくつかのインスタンス ハンドラーのいずれかがこのイベントを処理済みのマークでは既にことを示します。If reading this value, true indicates that either a class handler, or some instance handler along the route, has already marked this event handled. false は、いずれのハンドラーもイベントを処理済みとしてマークしていないことを示します。false.indicates that no such handler has marked the event handled.

既定値は false です。The default value is false.

次の例では、マークのイベントを処理するイベント ハンドラーを実装します。The following example implements an event handler that marks the event handled.

protected override void OnPreviewMouseRightButtonDown(System.Windows.Input.MouseButtonEventArgs e)
    e.Handled = true; //suppress the click event and other leftmousebuttondown responders
    MyEditContainer ec = (MyEditContainer)e.Source;
    if (ec.EditState)
    { ec.EditState = false; }
    { ec.EditState = true; }
Protected Overrides Sub OnPreviewMouseRightButtonDown(ByVal e As System.Windows.Input.MouseButtonEventArgs)
	e.Handled = True 'suppress the click event and other leftmousebuttondown responders
	Dim ec As MyEditContainer = CType(e.Source, MyEditContainer)
	If ec.EditState Then
		ec.EditState = False
		ec.EditState = True
	End If
End Sub


イベントを処理済みのマークを付けると、イベント ルート上のリスナーにルーティング イベントの可視性が制限されます。Marking the event handled will limit the visibility of the routed event to listeners along the event route. イベントは、ルートの残りの部分を移動してもが、唯一のハンドラーは、特にを追加HandledEventsToo``trueで、AddHandler(RoutedEvent, Delegate, Boolean)応答でメソッドの呼び出しが呼び出されます。The event does still travel the remainder of the route, but only handlers specifically added with HandledEventsToo true in the AddHandler(RoutedEvent, Delegate, Boolean) method call will be invoked in response. 既定のインスタンスのリスナーのハンドラー (で表されるものなどExtensible Application Markup Language (XAML)Extensible Application Markup Language (XAML)) は呼び出されません。Default handlers on instance listeners (such as those expressed in Extensible Application Markup Language (XAML)Extensible Application Markup Language (XAML)) will not be invoked. 処理済みとマークされているイベントを処理は、一般的なシナリオではありません。Handling events that are marked handled is not a common scenario.

コントロールの作成者の場合は、上の決定を行う独自のイベントを定義、コントロールのユーザーと、派生コントロールのすべてのユーザー イベントに関して、クラス レベルでの処理に影響し、では、その他の要素が、コントロールに含まれる可能性があります。または、コントロールが含まれています。If you are a control author defining your own events, the decisions you make regarding event handling at the class level will impact users of your control as well as any users of derived controls, and potentially other elements that are either contained by your control or that contain your control. 詳細については、「ルーティング イベントの処理済みとしてのマーキング、およびクラス処理」を参照してください。For more information, see Marking Routed Events as Handled, and Class Handling.

非常にまれな状況ではイベントを処理する適切な場所Handledがマークされているtrue、および変更することで、イベント引数を変更Handledfalseします。In very rare circumstances it is appropriate to handle events where Handled is marked true, and modify the event arguments by changing Handled to false. キーの処理などのコントロールの入力イベントの特定の領域で必要になるこのことKeyDownTextInputそれぞれさまざまなルーティング方法を使用しようと、下位レベルと高レベルの入力イベントの処理では、競合が発生します。This can be necessary in certain areas of input events of controls, such as key handling of KeyDown versus TextInput where low level and high level input events compete for the handling, and each is attempting to work with a different routing strategy.