InkInputConfiguration Class

Reference

Definition

Namespace:: Windows.UI.Input.Inking

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Manages which types of secondary input can be processed by the InkPresenter object.

public ref class InkInputConfiguration sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class InkInputConfiguration final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class InkInputConfiguration

Public NotInheritable Class InkInputConfiguration

Inheritance: Object Platform::Object IInspectable InkInputConfiguration

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v6.0)

Examples

Here, we show how to accept input as ink from pen, touch, and mouse devices, but ignore all input from pen barrel buttons and eraser tips.

public ScenarioBarrelEraserIgnore() 
{ 
    this.InitializeComponent(); 
    var inkPresenter = inkCanvas.InkPresenter; 
    inkPresenter.InputDeviceTypes = 
        Windows.UI.Core.CoreInputDeviceTypes.Pen |  
        Windows.UI.Core.CoreInputDeviceTypes.Touch | 
        Windows.UI.Core.CoreInputDeviceTypes.Mouse; 

    InkInputConfiguration inkInputConfiguration = 
        inkPresenter.InputConfiguration; 
    inkInputConfiguration.IsEraserInputEnabled = false; 
    inkInputConfiguration.IsPrimaryBarrelButtonInputEnabled = false; 
}

Remarks

To manage how secondary input is processed by your app, see InkInputProcessingConfiguration.

Properties

IsEraserInputEnabled	Gets or sets whether input from a pen's eraser tip is processed by the InkPresenter object.
IsPenHapticFeedbackEnabled	Gets or sets whether pen haptic feedback is enabled for the active pen.
IsPrimaryBarrelButtonInputEnabled	Gets or sets whether input from a pen's primary barrel button is processed by the InkPresenter object.

Applies to

Share via