プレビュー イベント

  • [アーティクル]

プレビュー イベントは、トンネリング イベントとも呼ばれ、ルートの方向がアプリケーション ルートからイベントを発生させた要素に向かって移動し、イベント データのソースとして報告されるルーティング イベントです。 すべてのイベント シナリオでプレビュー イベントがサポートされている、または必要とされているわけではありません。このトピックでは、プレビュー イベントが存在する状況、アプリケーションまたはコンポーネントでそれらを処理する方法、カスタム コンポーネントまたはクラスでプレビュー イベントを作成することが適切な場合について説明します。

プレビュー イベントと入力

一般的にプレビュー イベントを処理するときは、イベント データで処理されるイベントをマークすることにご注意ください。 発生させた要素 (イベント データでソースとして報告される要素) 以外の要素でプレビュー イベントを処理すると、発生した元のイベントを処理する機会が要素に提供されないという影響があります。 これが望ましい結果になる場合もあります。問題の要素がコントロールの合成内のリレーションシップに存在する場合は特にそうです。

特に入力イベントの場合、プレビュー イベントでもイベント データ インスタンスが同等のバブリング イベントと共有されます。 入力イベントを処理済みとマークするためにプレビュー イベント クラス ハンドラーを使用する場合、バブリング入力イベント クラス ハンドラーは呼び出されません。 また、イベントを処理済みとマークするためにプレビュー イベント インスタンス ハンドラーを使用する場合、通常、バブリング イベントのハンドラーは呼び出されません。 イベントが処理済みとしてマークされている場合でも、呼び出すオプションを使用してクラス ハンドラーまたはインスタンス ハンドラーを登録またはアタッチできますが、この手法は一般的には使用されません。

クラス処理とプレビュー イベントとの関係の詳細については、「ルーティング イベントの処理済みとしてのマーキング、およびクラス処理」を参照してください。

コントロールによるイベント抑制の回避

プレビュー イベントが一般的に使用されるシナリオの 1 つとして、入力イベントの複合コントロール処理があります。 場合によっては、コントロールの作成者が、おそらく、より多くの情報を伝達する、またはより具体的な動作を意味するコンポーネント定義のイベントを置き換える目的で、特定のイベントがコントロールから発生しないように抑制することがあります。 たとえば、マウスをキャプチャし、常に Button 自体によって発生する Click イベントを発生させるために、Windows Presentation Foundation (WPF) Button を使用して、Button またはその複合要素によって発生する MouseLeftButtonDown および MouseRightButtonDown バブリング イベントを抑制することができます。 イベントとそのデータはルートに沿って続行されますが、Button によってイベント データは Handled とマークされるため、handledEventsToo ケースで動作する必要があることを明確に示すイベントのハンドラーのみが呼び出されます。 アプリケーションのルートに向かう他の要素に、コントロール抑制イベントを処理する機会がまだ必要な場合、代替手段の 1 つは、true に指定された handledEventsToo を使って、コード内でハンドラーをアタッチすることです。 ただし、多くの場合、より簡単な手法は、処理するルーティング方向を変更して、入力イベントと同等のプレビューにすることです。 たとえば、コントロールによって MouseLeftButtonDown が抑制されている場合は、代わりに PreviewMouseLeftButtonDown のハンドラーをアタッチしてみてください。 この手法は、MouseLeftButtonDown などの基本要素の入力イベントに対してのみ機能します。 これらの入力イベントでは、トンネルおよびバブルのペアが使用され、両方のイベントが発生し、イベント データが共有されます。

これらの手法にはそれぞれに副作用または制限事項があります。 プレビュー イベントを処理することの副作用は、その時点でイベントを処理すると、バブリング イベントの処理が想定されているハンドラーが無効になる可能性があることです。そのため、制限事項は、まだルートのプレビュー部分にある間にイベントに処理済みとマークすることが、通常は推奨されないということです。 handledEventsToo 手法の制限事項は、属性として XAML で handledEventsToo ハンドラーを指定できないことです。ハンドラーがアタッチされる要素へのオブジェクト参照を取得した後、コードにイベント ハンドラーを登録する必要があります。

関連項目