InkInputProcessingConfiguration Class

  • Reference

Definition

Namespace:
Windows.UI.Input.Inking
Edit

Manages how input is processed by the InkPresenter object.

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

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

Primary input is not from (or modified by) a secondary affordance, such as a pen barrel button, pen eraser tip, right mouse button, or similar.

Secondary input, by default, is processed as primary input and rendered as an InkStroke by the InkPresenter. For custom handling of secondary input by your application, set InkInputProcessingConfiguration.RightDragAction to LeaveUnprocessed. This indicates that input should be passed through the InkPresenter as UnprocessedInput for custom processing.

If InkInputProcessingConfiguration.Mode is set to None, the value of RightDragAction is ignored and input is always passed as UnprocessedInput through to your app for custom processing.

If InkInputProcessingConfiguration.Mode is set to Inking or Erasing, the value of RightDragAction must be set to LeaveUnprocessed to pass input as UnprocessedInput through to your app for custom processing.

To manage what secondary input is processed by your app, see InkInputConfiguration.

Properties

Mode

Gets or sets how the InkPresenter object renders secondrary input from a pen barrel button, pen eraser tip, right mouse button, or similar on its associated InkCanvas control.

By default, this secondary input is processed as primary input and rendered as an InkStroke (see remarks).
RightDragAction

Gets or sets how the InkPresenter object handles secondary input from a pen barrel button, pen eraser tip, right mouse button, or similar.

By default, this secondary input is processed as primary input and rendered as an InkStroke (see remarks).

Applies to

See also