ICorePointerInputSource ICorePointerInputSource ICorePointerInputSource ICorePointerInputSource Interface

Definition

Defines the behavior of pointer input (for processing on a worker thread).

public : interface ICorePointerInputSource
struct winrt::Windows::UI::Core::ICorePointerInputSource
public interface ICorePointerInputSource
Public Interface ICorePointerInputSource
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

HasCapture HasCapture HasCapture HasCapture

Occurs if the pointer input source has capture functionality.

public : Platform::Boolean HasCapture { get; }
bool HasCapture();
public bool HasCapture { get; }
Public ReadOnly Property HasCapture As bool
Value
bool bool

True if the pointer input source has capture functionality; false if it does not.

PointerCursor PointerCursor PointerCursor PointerCursor

Gets or sets the current pointer cursor type.

public : CoreCursor PointerCursor { get; set; }
CoreCursor PointerCursor(); void PointerCursor(CoreCursor pointercursor);
public CoreCursor PointerCursor { get; set; }
Public ReadWrite Property PointerCursor As CoreCursor
Value
CoreCursor CoreCursor

The current pointer cursor.

PointerPosition PointerPosition PointerPosition PointerPosition

Gets the current position of the pointer in screen coordinates.

public : Point PointerPosition { get; }
Point PointerPosition();
public Point PointerPosition { get; }
Public ReadOnly Property PointerPosition As Point
Value
Point Point

The current position of the pointer, in screen coordinates.

Methods

ReleasePointerCapture() ReleasePointerCapture() ReleasePointerCapture() ReleasePointerCapture()

Stops the capture of pointer input data.

public : void ReleasePointerCapture()
void ReleasePointerCapture() const;
public void ReleasePointerCapture()
Public Function ReleasePointerCapture() As void

SetPointerCapture() SetPointerCapture() SetPointerCapture() SetPointerCapture()

Starts the capture of pointer input data, if the pointer input device supports it.

public : void SetPointerCapture()
void SetPointerCapture() const;
public void SetPointerCapture()
Public Function SetPointerCapture() As void

Events

PointerCaptureLost PointerCaptureLost PointerCaptureLost PointerCaptureLost

Occurs when the pointer input capture stream fails or is lost.

public : event TypedEventHandler PointerCaptureLost<Platform::Object, PointerEventArgs>
// Register
event_token PointerCaptureLost(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerCaptureLost(event_token const& cookie) const;

// Revoke with event_revoker
PointerCaptureLost_revoker PointerCaptureLost(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerCaptureLost<object, PointerEventArgs>
Public Event TypedEventHandler PointerCaptureLost( Of ( Of object ), ( Of PointerEventArgs ))

PointerEntered PointerEntered PointerEntered PointerEntered

Occurs when the pointer enters a UI element.

public : event TypedEventHandler PointerEntered<Platform::Object, PointerEventArgs>
// Register
event_token PointerEntered(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerEntered(event_token const& cookie) const;

// Revoke with event_revoker
PointerEntered_revoker PointerEntered(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerEntered<object, PointerEventArgs>
Public Event TypedEventHandler PointerEntered( Of ( Of object ), ( Of PointerEventArgs ))

PointerExited PointerExited PointerExited PointerExited

Occurs when the pointer exits a UI element.

public : event TypedEventHandler PointerExited<Platform::Object, PointerEventArgs>
// Register
event_token PointerExited(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerExited(event_token const& cookie) const;

// Revoke with event_revoker
PointerExited_revoker PointerExited(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerExited<object, PointerEventArgs>
Public Event TypedEventHandler PointerExited( Of ( Of object ), ( Of PointerEventArgs ))

PointerMoved PointerMoved PointerMoved PointerMoved

Occurs when the pointer is moved.

public : event TypedEventHandler PointerMoved<Platform::Object, PointerEventArgs>
// Register
event_token PointerMoved(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerMoved(event_token const& cookie) const;

// Revoke with event_revoker
PointerMoved_revoker PointerMoved(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerMoved<object, PointerEventArgs>
Public Event TypedEventHandler PointerMoved( Of ( Of object ), ( Of PointerEventArgs ))

PointerPressed PointerPressed PointerPressed PointerPressed

Occurs when a press action (such as a screen press or mouse click) is received for the pointer.

public : event TypedEventHandler PointerPressed<Platform::Object, PointerEventArgs>
// Register
event_token PointerPressed(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerPressed(event_token const& cookie) const;

// Revoke with event_revoker
PointerPressed_revoker PointerPressed(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerPressed<object, PointerEventArgs>
Public Event TypedEventHandler PointerPressed( Of ( Of object ), ( Of PointerEventArgs ))

PointerReleased PointerReleased PointerReleased PointerReleased

Occurs when a release action (such as a screen press-release or mouse click-release) is received for the pointer.

public : event TypedEventHandler PointerReleased<Platform::Object, PointerEventArgs>
// Register
event_token PointerReleased(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerReleased(event_token const& cookie) const;

// Revoke with event_revoker
PointerReleased_revoker PointerReleased(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerReleased<object, PointerEventArgs>
Public Event TypedEventHandler PointerReleased( Of ( Of object ), ( Of PointerEventArgs ))

PointerWheelChanged PointerWheelChanged PointerWheelChanged PointerWheelChanged

Occurs when the pointer wheel (mouse or virtual) has changed position.

public : event TypedEventHandler PointerWheelChanged<Platform::Object, PointerEventArgs>
// Register
event_token PointerWheelChanged(TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;

// Revoke with event_token
void PointerWheelChanged(event_token const& cookie) const;

// Revoke with event_revoker
PointerWheelChanged_revoker PointerWheelChanged(auto_revoker_t, TypedEventHandler<Platform::Object, PointerEventArgs> const& handler) const;
public event TypedEventHandler PointerWheelChanged<object, PointerEventArgs>
Public Event TypedEventHandler PointerWheelChanged( Of ( Of object ), ( Of PointerEventArgs ))