InkUnprocessedInput Class

Definition

Provides properties and events for custom processing of ink data from an InkCanvas control. The data is not processed by the InkPresenter.

Use InkInputProcessingConfiguration to identify the data to pass through as UnprocessedInput.

public ref class InkUnprocessedInput sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class InkUnprocessedInput final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class InkUnprocessedInput
Public NotInheritable Class InkUnprocessedInput
Inheritance
Object Platform::Object IInspectable InkUnprocessedInput
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Input from various devices (including touch, pen, and mouse) is received, processed, and managed as pointer input. User interactions based on any of these devices can produce a PointerEntered, PointerExited, PointerReleased, PointerPressed, PointerMoved, PointerLost, or PointerHovered, event. For more info, see Handle pointer input.

Properties

InkPresenter

Gets the InkPresenter object associated with the InkCanvas control capturing the InkStroke data. The InkPresenter does not process the input, instead the data is passed through for custom processing by the app.

Events

PointerEntered

Occurs when a pointer enters the hit test, or bounding, area of an InkCanvas control.

PointerExited

Occurs when a pointer leaves the hit test, or bounding, area of an InkCanvas control.

PointerHovered

Occurs when a pointer is detected over, but not down or in contact with, the hit test, or bounding, area of an InkCanvas control.

PointerLost

Occurs when a pointer is no longer detected in, or over, the hit test, or bounding, area of an InkCanvas control.

Typically, a pointer is lost if the contact moves outside the InkCanvas control or the contact is captured by another element.

PointerMoved

Occurs when a pointer moves within the hit test, or bounding, area of an InkCanvas control.

PointerPressed

Occurs when a pointer registers contact within the hit test, or bounding, area of an InkCanvas control. This can be when a mouse button is pressed or the digitizer surface is touched by a finger or pen.

PointerReleased

Can occur when a pointer associated with a PointerPressed event is lifted, or released, while within the hit test, or bounding, area of an InkCanvas control.

PointerReleased is not guaranteed to occur in concert with PointerPressed, as PointerLost or PointerExited might occur instead. You should handle all events that can conclude PointerPressed.

Some reasons why PointerReleased might not occur include:

  • Differences in how specific hardware handles input
  • A programmatic pointer capture from a different pointer
  • 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

Applies to

See also