PreProcessInputEventArgs Class

 

Provides data for preprocess input events.

Namespace:   System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.EventArgs
    System.Windows.Input.NotifyInputEventArgs
      System.Windows.Input.ProcessInputEventArgs
        System.Windows.Input.PreProcessInputEventArgs

public sealed class PreProcessInputEventArgs : ProcessInputEventArgs

NameDescription
System_CAPS_pubpropertyCanceled

Determines whether processing of the input event was canceled.

System_CAPS_pubpropertyInputManager

Gets the input manager processing the input event. (Inherited from NotifyInputEventArgs.)

System_CAPS_pubpropertyStagingItem

Gets the staging area input item being processed by the input manager. (Inherited from NotifyInputEventArgs.)

NameDescription
System_CAPS_pubmethodCancel()

Cancels the processing of the input event.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodPeekInput()

Gets, but does not pop, the input event on the top of the staging area stack.(Inherited from ProcessInputEventArgs.)

System_CAPS_pubmethodPopInput()

Removes the input event off the top of the staging area stack. (Inherited from ProcessInputEventArgs.)

System_CAPS_pubmethodPushInput(InputEventArgs, StagingAreaInputItem)

Puts the specified input event onto the top of the specified staging area stack. (Inherited from ProcessInputEventArgs.)

System_CAPS_pubmethodPushInput(StagingAreaInputItem)

Puts the specified input event onto the top of the staging area stack. (Inherited from ProcessInputEventArgs.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

Canceling a pre-process input stops the input from being processed further. Listen for the PreNotifyInput to determine if another handler canceled a pre-process input.

The input staging area processes input into WPF events.

All PreProcessInput event handlers are called, even if one of the handlers cancels the input. To verify if a handler further up the tree canceled the input, listen for the PreNotifyInput event.

PreProcessInputEventArgs is used with the PreProcessInput event.

Input is processed in WPF in the follow stages:

  1. Pre-process stage. The input manager raises the PreProcessInput event.

  2. Pre-notify stage. The input manager raises the PreNotifyInput event.

  3. The WPF input event or events are raised.

  4. Post-notify stage. The input manager raises the PostNotifyInput event.

  5. Post-process stage. The input manager raises the PostProcessInput event.

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: