CoreWetStrokeUpdateSource Class

  • Reference

Definition

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

Represents the InkPresenter that manages the input, processing, and rendering of ink stroke data.

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

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

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

Use the Windows.UI.Input.Inking.Core events to process "wet" ink data before it is rendered by the InkPresenter. This can be useful when providing a digital stencil, such as a ruler or protractor, to constrain and modify a stroke while it is "wet", or mask select areas of the canvas from ink strokes.

An ink stroke always triggers either a WetStrokeCompleted or a WetStrokeCanceled event.

Properties

InkPresenter

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

Methods

Create(InkPresenter)

Retrieves a CoreWetStrokeUpdateSource object for handling "wet" ink strokes prior to processing by an InkPresenter object.

Events

WetStrokeCanceled

Occurs when the InkPresenter stops processing an ink stroke in an unexpected way, CoreWetStrokeDisposition is set to Canceled, or the input is invalid, indicating the stroke was not completed.

For example, when ink input bubbles up to another system event handler, such as a context menu.
WetStrokeCompleted

Occurs after the InkPresenter stops processing an ink stroke (WetStrokeStopping) or CoreWetStrokeDisposition is set to Completed, indicating the stroke is complete.

Subsequent ink input is considered a new stroke.
WetStrokeContinuing

Occurs after the InkPresenter starts processing an ink stroke and before it stops processing the same stroke, indicating ink data continues to be captured.
WetStrokeStarting

Occurs when the InkPresenter starts processing an ink stroke.
WetStrokeStopping

Occurs when the InkPresenter stops processing an ink stroke, but before the stroke is finalized (WetStrokeCompleted).

Applies to

See also