SurfaceDialOptions Class

Definition

Namespace:

Microsoft.Toolkit.Uwp.UI

Assembly:

Microsoft.Toolkit.Uwp.UI.dll

Package:

Microsoft.Toolkit.Uwp.UI v7.1.2

A model containing options for configuring the Surface Dial support through TextBoxExtensions.

public sealed class SurfaceDialOptions : Windows.UI.Xaml.DependencyObject

type SurfaceDialOptions = class
    inherit DependencyObject

Public NotInheritable Class SurfaceDialOptions
Inherits DependencyObject

Inheritance

Windows.UI.Xaml.DependencyObject

SurfaceDialOptions

Constructors

SurfaceDialOptions()

Properties

EnableHapticFeedback	Gets or sets a value indicating whether to enable the haptic feedback when rotating the dial for the give TextBox. This is enabled by default.
EnableMinMaxValue	Gets or sets a value indicating whether to limit the value in the Windows.UI.Xaml.Controls.TextBox to MinValue and MaxValue.
EnableTapToNextControl	Gets or sets a value indicating whether to automatically try to focus the next focusable element from the Surface Dial enabled Windows.UI.Xaml.Controls.TextBox. This is on by default.
Icon	Gets or sets the default icon of the menu item that gets added. This will be visible if a user opens their Surface Dial menu by long-pressing the device. Defaults to Windows.UI.Input.RadialControllerMenuKnownIcon.Ruler.
MaxValue	Gets or sets the maximum value the Windows.UI.Xaml.Controls.TextBox can have when modifying it using a Surface Dial. Default is 100.0.
MinValue	Gets or sets the minimum value the Windows.UI.Xaml.Controls.TextBox can have when modifying it using a Surface Dial. Default is -100.0.
RotationResolutionInDegrees	Gets or sets the Windows.UI.Input.RadialController.RotationResolutionInDegrees property for the extension which is the amount the dial needs to rotate to trigger a change. Default is 10.
StepValue	Gets or sets the amount the Windows.UI.Xaml.Controls.TextBox value will be modified for each RotationResolutionInDegrees step on the Surface Dial. This can be any double value.