PointerVisualizationSettings PointerVisualizationSettings PointerVisualizationSettings PointerVisualizationSettings Class

Definition

Namespace:
Windows.UI.Input Windows.UI.Input Windows.UI.Input Windows.UI.Input
Edit

Provides access to the visual feedback settings for pointer input.

Important

Pointer visualizations are supported by the Desktop device family only.

public : sealed class PointerVisualizationSettings : IPointerVisualizationSettingspublic sealed class PointerVisualizationSettings : IPointerVisualizationSettingsPublic NotInheritable Class PointerVisualizationSettings Implements IPointerVisualizationSettings// You can use this class in JavaScript.
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute StaticAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following example demonstrates the use of GetForCurrentView to retrieve an instance of PointerVisualizationSettings through which the visual feedback preferences for the current app are set.


var pointerVisualizationSettings = Windows.UI.Input.PointerVisualizationSettings.getForCurrentView();
pointerVisualizationSettings.isContactFeedbackEnabled = false;
pointerVisualizationSettings.isBarrelButtonFeedbackEnabled = false;

Remarks

Call GetForCurrentView to get a PointerVisualizationSettings object associated with the active app. This object is used to set the visual feedback preferences for the app.

This

Properties

IsBarrelButtonFeedbackEnabled IsBarrelButtonFeedbackEnabled IsBarrelButtonFeedbackEnabled IsBarrelButtonFeedbackEnabled

Edit

Gets or sets a value that indicates whether visual feedback is enabled for pen/stylus input when the barrel button is pressed.

Important

Pointer visualizations are supported by the Desktop device family only.

public : PlatForm::Boolean IsBarrelButtonFeedbackEnabled { get; set; }public bool IsBarrelButtonFeedbackEnabled { get; set; }Public ReadWrite Property IsBarrelButtonFeedbackEnabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if feedback is enabled; otherwise false. The default value is true.

IsContactFeedbackEnabled IsContactFeedbackEnabled IsContactFeedbackEnabled IsContactFeedbackEnabled

Edit

Gets or sets a value that indicates whether visual feedback is enabled when a pointer contact is detected.

Important

Pointer visualizations are supported by the Desktop device family only.

public : PlatForm::Boolean IsContactFeedbackEnabled { get; set; }public bool IsContactFeedbackEnabled { get; set; }Public ReadWrite Property IsContactFeedbackEnabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if feedback is enabled; otherwise false. The default value is true.

Methods

GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView()

Edit

Gets a PointerVisualizationSettings object associated with the current app.

Important

Pointer visualizations are supported by the Desktop device family only.

public : static PointerVisualizationSettings GetForCurrentView()public static PointerVisualizationSettings GetForCurrentView()Public Static Function GetForCurrentView() As PointerVisualizationSettings// You can use this method in JavaScript.
Returns
PointerVisualizationSettings PointerVisualizationSettings PointerVisualizationSettings PointerVisualizationSettings

The PointerVisualizationSettings object associated with the current app.

Remarks

Each app has a PointerVisualizationSettings object associated with it. When setting the visual feedback preferences, you use the GetForCurrentView method to get the PointerVisualizationSettings object that is associated with the active app. After you have the appropriate PointerVisualizationSettings object, you can set the visual feedback preferences.

See Also