CoreWetStrokeUpdateSource
CoreWetStrokeUpdateSource
CoreWetStrokeUpdateSource
CoreWetStrokeUpdateSource
Class
Definition
Represents the InkPresenter that manages the input, processing, and rendering of ink stroke data.
public : sealed class CoreWetStrokeUpdateSource : ICoreWetStrokeUpdateSourcepublic sealed class CoreWetStrokeUpdateSource : ICoreWetStrokeUpdateSourcePublic NotInheritable Class CoreWetStrokeUpdateSource Implements ICoreWetStrokeUpdateSource// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
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 InkPresenter InkPresenter InkPresenter
Gets the InkPresenter object that manages the input, processing, and rendering of ink stroke data.
public : InkPresenter InkPresenter { get; }public InkPresenter InkPresenter { get; }Public ReadOnly Property InkPresenter As InkPresenter// This API is not available in Javascript.
Object that manages the input, processing, and rendering of ink stroke data.
- See Also
Methods
Create(InkPresenter) Create(InkPresenter) Create(InkPresenter) Create(InkPresenter)
Retrieves a CoreWetStrokeUpdateSource object for handling "wet" ink strokes prior to processing by an InkPresenter object.
public : static CoreWetStrokeUpdateSource Create(InkPresenter inkPresenter)public static CoreWetStrokeUpdateSource Create(InkPresenter inkPresenter)Public Static Function Create(inkPresenter As InkPresenter) As CoreWetStrokeUpdateSource// This API is not available in Javascript.
- inkPresenter
- InkPresenter InkPresenter InkPresenter InkPresenter
Object that manages the input, processing, and rendering of InkStroke data.
Object that handles the "wet" ink data for an InkPresenter object.
- See Also
Events
WetStrokeCanceled WetStrokeCanceled WetStrokeCanceled 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.
public : event TypedEventHandler WetStrokeCanceled<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>public event TypedEventHandler WetStrokeCanceled<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>Public Event WetStrokeCanceled<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>// This API is not available in Javascript.
Remarks
An ink stroke always triggers either a WetStrokeCompleted or a WetStrokeCanceled event.
NewInkPoints is always empty for the WetStrokeCompleted and WetStrokeCanceled events.
NewInkPoints might be empty for the WetStrokeStopping event.
- See Also
WetStrokeCompleted WetStrokeCompleted WetStrokeCompleted 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.
public : event TypedEventHandler WetStrokeCompleted<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>public event TypedEventHandler WetStrokeCompleted<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>Public Event WetStrokeCompleted<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>// This API is not available in Javascript.
Remarks
An ink stroke always triggers either a WetStrokeCompleted or a WetStrokeCanceled event.
NewInkPoints is always empty for the WetStrokeCompleted and WetStrokeCanceled events.
NewInkPoints might be empty for the WetStrokeStopping event.
- See Also
WetStrokeContinuing WetStrokeContinuing WetStrokeContinuing 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.
public : event TypedEventHandler WetStrokeContinuing<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>public event TypedEventHandler WetStrokeContinuing<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>Public Event WetStrokeContinuing<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>// This API is not available in Javascript.
- See Also
WetStrokeStarting WetStrokeStarting WetStrokeStarting WetStrokeStarting
Occurs when the InkPresenter starts processing an ink stroke.
public : event TypedEventHandler WetStrokeStarting<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>public event TypedEventHandler WetStrokeStarting<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>Public Event WetStrokeStarting<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>// This API is not available in Javascript.
- See Also
WetStrokeStopping WetStrokeStopping WetStrokeStopping WetStrokeStopping
Occurs when the InkPresenter stops processing an ink stroke, but before the stroke is finalized (WetStrokeCompleted ).
public : event TypedEventHandler WetStrokeStopping<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>public event TypedEventHandler WetStrokeStopping<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>Public Event WetStrokeStopping<CoreWetStrokeUpdateSource, CoreWetStrokeUpdateEventArgs>// This API is not available in Javascript.
Remarks
NewInkPoints is always empty for the WetStrokeCompleted and WetStrokeCanceled events.
NewInkPoints might be empty for the WetStrokeStopping event.
- See Also