NumberBox Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents a control that can be used to display and edit numbers.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class NumberBox : Control

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class NumberBox : Control

Public Class NumberBox
Inherits Control

Inheritance

Control

NumberBox

Attributes

MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Number box.

Open the WinUI 2 Gallery app and see the NumberBox in action.

The WinUI 2 Gallery app includes interactive examples of most WinUI 2 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Remarks

This control supports validation, increment stepping, and computing inline calculations of basic equations such as multiplication, division, addition, and subtraction.

Control style and template

You can modify the default Style and ControlTemplate to give the control a unique appearance. For information about modifying a control's style and template, see XAML styles. The default style, template, and resources that define the look of the control are included in the generic.xaml file. For design purposes, generic.xaml is installed with the WinUI (Microsoft.UI.Xaml) NuGet package. By default, this location is \Users\<username>\.nuget\packages\microsoft.ui.xaml\<version>\lib\uap10.0\Microsoft.UI.Xaml\Themes\generic.xaml. Styles and resources from different versions of WinUI might have different values.

XAML also includes resources that you can use to modify the colors of a control in different visual states without modifying the control template (modifying these resources is preferred to setting properties). For more info, see the Light-weight styling section of the XAML styles article.

Constructors

NumberBox()

Initializes a new instance of the NumberBox class. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

AcceptsExpression	Gets or sets a value that indicates whether the control accepts and evaluates a basic formulaic expression entered as input. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
AcceptsExpressionProperty	Identifies the AcceptsExpression dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Description	Gets or sets content that is shown below the control. The content should provide guidance about the input expected by the control. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
DescriptionProperty	Identifies the Description dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Header	Gets or sets the content for the control's header. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HeaderProperty	Identifies the Header dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HeaderTemplate	Gets or sets the DataTemplate used to display the content of the control's header. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
HeaderTemplateProperty	Identifies the HeaderTemplate dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsWrapEnabled	Gets or sets a value that indicates whether line breaking occurs when header text extends beyond the available width of the control. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsWrapEnabledProperty	Identifies the IsWrapEnabled dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
LargeChange	Gets or sets a number that is added to or subtracted from Value when a large change is made, such as with the PageUp and PageDown keys. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
LargeChangeProperty	Identifies the LargeChange dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Maximum	Gets or sets the numerical maximum for Value. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MaximumProperty	Identifies the Maximum dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Minimum	Gets or sets the numerical minimum for Value. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
MinimumProperty	Identifies the Minimum dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
NumberFormatter	Gets or sets the object used to specify the formatting of Value. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
NumberFormatterProperty	Identifies the NumberFormatter dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PlaceholderText	Gets or sets the text that is displayed in the data entry field of the control until the value is changed by a user action or some other operation. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PlaceholderTextProperty	Identifies the PlaceholderText dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PreventKeyboardDisplayOnProgrammaticFocus	Gets or sets a value that indicates whether the on-screen keyboard is shown when the control receives focus programmatically. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PreventKeyboardDisplayOnProgrammaticFocusProperty	Identifies the PreventKeyboardDisplayOnProgrammaticFocus dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SelectionFlyout	Gets or sets the flyout that is shown when text is selected, or null if no flyout is shown. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SelectionFlyoutProperty	Identifies the SelectionFlyout dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SelectionHighlightColor	Gets or sets the brush used to highlight the selected text. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SelectionHighlightColorProperty	Identifies the SelectionHighlightColor dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SmallChange	Gets or sets a number that is added to or subtracted from Value when a small change is made, such as with an arrow key or scrolling. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SmallChangeProperty	Identifies the SmallChange dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SpinButtonPlacementMode	Gets or sets a value that indicates the placement of buttons used to increment or decrement the Value property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SpinButtonPlacementModeProperty	Identifies the SpinButtonPlacementMode dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Text	Gets or sets the string type representation of the Value property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
TextProperty	Identifies the Text dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
TextReadingOrder	Gets or sets a value that indicates how the reading order is determined for the NumberBox. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
TextReadingOrderProperty	Identifies the TextReadingOrder dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ValidationMode	Gets or sets a value that specifies the input validation behavior to invoke when invalid input is entered. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ValidationModeProperty	Identifies the ValidationMode dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Value	Gets or sets the numeric value of a NumberBox. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ValueProperty	Identifies the Value dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Events

ValueChanged

Occurs after the user triggers evaluation of new input by pressing the Enter key, clicking a spin button, or by changing focus. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

See also

• NumberBoxSpinButtonPlacementMode
• NumberBoxValidationMode
• NumberBoxValueChangedEventArgs