PointerEventArgs PointerEventArgs PointerEventArgs PointerEventArgs Class

Definition

Contains the arguments returned by the last pointer event.

public : sealed class PointerEventArgs : ICoreWindowEventArgs, IPointerEventArgs
struct winrt::Windows::UI::Core::PointerEventArgs : ICoreWindowEventArgs, IPointerEventArgs
public sealed class PointerEventArgs : ICoreWindowEventArgs, IPointerEventArgs
Public NotInheritable Class PointerEventArgs Implements ICoreWindowEventArgs, IPointerEventArgs
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

void SetWindow(CoreWindow const & window)
{
    window.PointerCursor(Windows::UI::Core::CoreCursor{ CoreCursorType::Arrow, 0 });

    window.PointerPressed({ this, &App::OnPointerPressed });
    window.PointerReleased({ this, &App::OnPointerReleased });
    window.PointerMoved({ this, &App::OnPointerMoved });
}

// Pointer event data in PointerEventArgs.
void OnPointerPressed(Windows::UI::Core::CoreWindow const& /* sender */,
    Windows::UI::Core::PointerEventArgs const& /* args */) {}

void OnPointerReleased(Windows::UI::Core::CoreWindow const& /* sender */,
    Windows::UI::Core::PointerEventArgs const& /* args */) {}

void OnPointerMoved(Windows::UI::Core::CoreWindow const& /* sender */,
    Windows::UI::Core::PointerEventArgs const& /* args */) {}
// 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);

    // ...
}

Remarks

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

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.

Handled Handled Handled Handled

Gets or sets whether the pointer event was handled.

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.

Methods

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

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

See Also