CoreInkIndependentInputSource Class

  • Reference

Definition

Namespace:
Windows.UI.Input.Inking.Core
Edit

Provides properties, methods, and events for handling pointer input prior to processing by an InkPresenter object.

Important

These events occur on the ink background thread. For this reason, ensure any custom processing of ink input is as lightweight as possible to avoid degraded performance and to keep your app as responsive as possible.

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

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Standard Windows.UI.Input.Inking events occur after ink strokes have been rendered.

Use the Windows.UI.Input.Inking.Core pointer events to intercept raw pointer data and suppress, or cancel, ink rendering at any point along a stroke. This can be useful when protecting existing ink strokes or providing custom gesture support, such as press and hold, without creating ink artifacts.

Input from various devices (including touch, pen, and mouse) is received, processed, and managed as pointer input. User interactions from any of these devices can produce the following events. For more info, see Handle pointer input.

Properties

InkPresenter

Gets the InkPresenter object that manages the input, processing, and rendering of ink stroke data.
PointerCursor

Gets or sets the pointer cursor used when inking.

Methods

Create(InkPresenter)

Retrieves a CoreInkIndependentInputSource object for handling pointer input prior to processing by an InkPresenter object.

Events

PointerEntering

Occurs as a pointer is detected entering the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.
PointerExiting

Occurs as a pointer is detected leaving the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.
PointerHovering

Occurs as a pointer is detected over, but not down or in contact with, the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.
PointerLost

Occurs as a pointer is no longer detected in, or over, the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

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

Occurs as a pointer moves within the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.
PointerPressing

Occurs as a pointer registers contact within the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object. This can be when a mouse button is pressed or the digitizer surface is touched by a finger or pen.
PointerReleasing

Can occur as a pointer associated with a PointerPressing event is lifted, or released, while within the hit test, or bounding, area of the InkCanvas associated with the InkPresenter object.

PointerReleasing is not guaranteed to occur in concert with PointerPressing, as PointerLost or PointerExiting might occur instead. You should handle all events that can conclude PointerPressing.

Some reasons why PointerReleasing 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