Pointer​Event​Args Pointer​Event​Args Pointer​Event​Args Pointer​Event​Args Class

Definition

Contains the arguments returned by the last pointer event.

public : sealed class PointerEventArgs : ICoreWindowEventArgs, IPointerEventArgspublic sealed class PointerEventArgs : ICoreWindowEventArgs, IPointerEventArgsPublic NotInheritable Class PointerEventArgs Implements ICoreWindowEventArgs, IPointerEventArgs// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This object is returned by a delegate registered for one of the following events:


// returning pointer events data through PointerEventArgs

void MyCoreWindowEvents::SetWindow( // implementation called by CoreApplication::Run(), provided for context
    _In_ CoreWindow^ window
    )
{
    window->PointerCursor = ref new CoreCursor(CoreCursorType::Arrow, 0);

    // ...
    window->PointerPressed +=
        ref new TypedEventHandler<CoreWindow^, PointerEventArgs^>(this, &CoreWindowEvents::OnPointerPressed);
    window->PointerReleased +=
        ref new TypedEventHandler<CoreWindow^, PointerEventArgs^>(this, &CoreWindowEvents::OnPointerReleased);
    window->PointerMoved +=
        ref new TypedEventHandler<CoreWindow^, PointerEventArgs^>(this, &CoreWindowEvents::OnPointerMoved);

    // ...

}
Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).

Properties

CurrentPoint CurrentPoint CurrentPoint CurrentPoint

Gets the pointer data of the last pointer event.

public : PointerPoint CurrentPoint { get; }public PointerPoint CurrentPoint { get; }Public ReadOnly Property CurrentPoint As PointerPoint// This API is not available in Javascript.
Value
PointerPoint PointerPoint PointerPoint PointerPoint

Information about the state and screen position of the pointer.

Remarks

CurrentPoint corresponds to the last point retrieved by GetIntermediatePoints.

void MyCoreWindowEvents::GetPointerInfo(
    _In_ PointerEventArgs^ args
    )
{
    Windows::UI::Input::PointerPoint^ currentPoint = args->CurrentPoint;

          // save or print currentPoint 

}

Handled Handled Handled Handled

Gets or sets whether the pointer event was handled.

public : PlatForm::Boolean Handled { get; set; }public bool Handled { get; set; }Public ReadWrite Property Handled As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

True if the pointer event has been handled by the appropriate delegate; false if it has not.

KeyModifiers KeyModifiers KeyModifiers KeyModifiers

Gets the keyboard key or keys used to modify the pointer input, such as the "Ctrl" key when pressed in conjunction with another key, as in Ctrl+C.

public : VirtualKeyModifiers KeyModifiers { get; }public VirtualKeyModifiers KeyModifiers { get; }Public ReadOnly Property KeyModifiers As VirtualKeyModifiers// This API is not available in Javascript.

Methods

GetIntermediatePoints() GetIntermediatePoints() GetIntermediatePoints() GetIntermediatePoints()

Retrieves the pointer data for up to the last 64 pointer locations since the last pointer event.

public : IVector<PointerPoint> GetIntermediatePoints()public IList<PointerPoint> GetIntermediatePoints()Public Function GetIntermediatePoints() As IList( Of PointerPoint )// This API is not available in Javascript.
Returns
IVector<PointerPoint> IList<PointerPoint> IList<PointerPoint> IList<PointerPoint>

The data for each pointer.

See Also