Expand Minimize

UIElement.PointerCanceled event

Applies to Windows and Windows Phone

Occurs when a pointer that made contact abnormally loses contact.

Syntax

Public Event PointerCanceled As PointerEventHandler

<uiElement PointerCanceled="eventhandler"/>

Event information

Delegate PointerEventHandler

Remarks

Some of the reasons why you might get a PointerCanceled occurrence are:

  • User actions that change the relationship of the display area, such as changing resolution or monitor settings
  • Input interactions such as a stylus touching the same surface as a previous touch action
  • The user logs off or similar interruptions that aren't app-specific
  • The number of simultaneous contacts exceeded the number supported by the device

Note  PointerCanceled might fire instead of PointerReleased. Don't rely on PointerPressed and PointerReleased events always occurring in pairs. To function properly, your app must listen for and handle all events that represent the possible conclusions to a Press action, and that includes PointerCanceled.

If PointerCanceled fires, any pointer captures by that pointer are released and PointerCaptureLost won't fire in this case. For more info on pointer capture, see CapturePointer.

When handling a PointerCanceled event, anticipate that some of the event data normally available for a pointer event won't be meaningful in the PointerRoutedEventArgs object you get through your handler. For example, the Position of the pointer is invalid because the pointer no longer exists.

PointerCanceled is a routed event. For more info on the routed event concept, see Events and routed events overview.

PointerCanceled supports the ability to attach event handlers to the route that will be invoked even if the event data for the event is marked Handled. See AddHandler.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml
Windows::UI::Xaml [C++]

Metadata

Windows.winmd

See also

UIElement
PointerReleased
PointerPressed
CapturePointer
Quickstart: Touch input
Hit testing and input events
XAML user input events sample

 

 

Show:
© 2014 Microsoft