Expand Minimize

UIElement.PointerCaptures property

Applies to Windows and Windows Phone

Gets the set of all captured pointers, represented as Pointer values.

Syntax


public IReadOnlyList<Pointer> PointerCaptures { get; }

Property value

Type: IVectorView<Pointer> [C++] | System.Collections.Generic.IReadOnlyList<Pointer> [.NET]

The collection of captured pointers, each represented as a Pointer object.

Remarks

For more info on how to capture a pointer and why you might want to do so, see CapturePointer.

Because there are input scenarios such as manipulations that involve more than one pointer point, the Windows Runtime enables capturing more than one pointer at a time. The PointerCaptures property exposes a view of which pointer points are currently captured by the UIElement.

This property's value is calculated based on the results of other actions. Calling CapturePointer adds to the internal collection that PointerCaptures provides a read-only view of. Calling ReleasePointerCapture removes from the collection. ReleasePointerCaptures clears the collection. User action that invalidates pointer capture such as releasing from a pointer point also changes capture state and thus the collection. For more info, see Responding to mouse input and Quickstart: Pointers.

The collection is not necessarily indexed by PointerId. To find a specific PointerId, you must check the items in the collection and reference a specific Pointer.

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
CapturePointer
PointerCaptures
Pointer
Quickstart: Handling pointer input

 

 

Show:
© 2014 Microsoft