Class SfNumericUpDown

Represents a control that allows the user to increment and decrement a numeric value.

Inheritance

System.Object

SfNumericUpDown

Namespace: Syncfusion.SfNumericUpDown.XForms

Assembly: Syncfusion.SfNumericUpDown.XForms.dll

Syntax

public class SfNumericUpDown : View, IParentThemeElement, IThemeElement

Constructors

SfNumericUpDown()

Initializes a new instance of the SfNumericUpDown class. Represents a control that allows the user to increment and decrement a numeric value.

Declaration

public SfNumericUpDown()

Fields

AllowNullProperty

Using a DependencyProperty as the backing store for AllowNull property.

Declaration

public static readonly BindableProperty AllowNullProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AutoReverseProperty

Using a DependencyProperty as the backing store for AutoReverse property.

Declaration

public static readonly BindableProperty AutoReverseProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BorderColorProperty

Using a DependencyProperty as the backing store for BorderColor property.

Declaration

public static readonly BindableProperty BorderColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CultureProperty

Using a DependencyProperty as the backing store for Culture property.

Declaration

public static readonly BindableProperty CultureProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CustomViewProperty

Using a DependencyProperty as the backing store for CustomView property.

Declaration

public static readonly BindableProperty CustomViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DecrementButtonSettingsProperty

The properties of UpDownButtonSettings class that contains all the customization.

Declaration

public static readonly BindableProperty DecrementButtonSettingsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DecrementButtonViewProperty

Using a DependencyProperty as the backing store for DecrementButtonView property.

Declaration

public static readonly BindableProperty DecrementButtonViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

EnableGroupSeparatorProperty

Using a DependencyProperty as the backing store for EnableGroupSeparator property.

Declaration

public static readonly BindableProperty EnableGroupSeparatorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontAttributeProperty

Using a DependencyProperty as the backing store for FontAttributes property.

Declaration

public static readonly BindableProperty FontAttributeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontFamilyProperty

Using a DependencyProperty as the backing store for FontFamily property.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontProperty

Using a DependencyProperty as the backing store for Font property.

Declaration

public static readonly BindableProperty FontProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontSizeProperty

Using a DependencyProperty as the backing store for FontSize property.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FormatStringProperty

Using a DependencyProperty as the backing store for FormatString property.

Declaration

public static readonly BindableProperty FormatStringProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IncrementButtonSettingsProperty

The properties of UpDownButtonSettings class that contains all the customization.

Declaration

public static readonly BindableProperty IncrementButtonSettingsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IncrementButtonViewProperty

Using a DependencyProperty as the backing store for IncrementButtonView property.

Declaration

public static readonly BindableProperty IncrementButtonViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsEditableProperty

Using a DependencyProperty as the backing store for AutoReverse property.

Declaration

public static readonly BindableProperty IsEditableProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MaximumDecimalDigitsProperty

Using a DependencyProperty as the backing store for MaximumNumberDecimalDigits property.

Declaration

public static readonly BindableProperty MaximumDecimalDigitsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MaximumProperty

Using a DependencyProperty as the backing store for Maximum property.

Declaration

public static readonly BindableProperty MaximumProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MinimumProperty

Using a DependencyProperty as the backing store for Minimum property.

Declaration

public static readonly BindableProperty MinimumProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ParsingModeProperty

Using a DependencyProperty as the backing store for ParserMode property.

Declaration

public static readonly BindableProperty ParsingModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

PercentDisplayModeProperty

Using a DependencyProperty as the backing store for PercentDisplayMode property.

Declaration

public static readonly BindableProperty PercentDisplayModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectAllOnFocusProperty

The SelectAllOnFocus property.

Declaration

public static readonly BindableProperty SelectAllOnFocusProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty	true if enable group separator; otherwise, false.

SpinButtonAlignmentProperty

Using a DependencyProperty as the backing store for SpinButtonAlignment property.

Declaration

public static readonly BindableProperty SpinButtonAlignmentProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SpinValidationProperty

Using a DependencyProperty as the backing store for SpinValidation property.

Declaration

public static readonly BindableProperty SpinValidationProperty

Field Value

Type
Xamarin.Forms.BindableProperty

StepValueProperty

Using a DependencyProperty as the backing store for StepValue property.

Declaration

public static readonly BindableProperty StepValueProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextAlignmentProperty

Using a DependencyProperty as the backing store for TextAlignment property.

Declaration

public static readonly BindableProperty TextAlignmentProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextColorProperty

Using a DependencyProperty as the backing store for TextColor property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

UpDownButtonColorProperty

Using a DependencyProperty as the backing store for UpDownButtonColor property.

Declaration

public static readonly BindableProperty UpDownButtonColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ValueChangeModeProperty

Using a DependencyProperty as the backing store for ValueChangeMode property.

Declaration

public static readonly BindableProperty ValueChangeModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ValueProperty

Using a DependencyProperty as the backing store for Value property.

Declaration

public static readonly BindableProperty ValueProperty

Field Value

Type
Xamarin.Forms.BindableProperty

WatermarkColorProperty

Using a DependencyProperty as the backing store for WatermarkColor property.

Declaration

public static readonly BindableProperty WatermarkColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

WatermarkProperty

Using a DependencyProperty as the backing store for Watermark property.

Declaration

public static readonly BindableProperty WatermarkProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

AllowNull

Gets or sets a value indicating whether null value can be set or not in input field.

Declaration

public bool AllowNull { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

AutoReverse

Gets or sets a value indicating whether that enable or disable the cyclic behavior when value reached minimum or maximum value.

Declaration

public bool AutoReverse { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

BorderColor

Gets or sets the Border color of the input field.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

Culture

Gets or sets the value for a culture to display the value based on it.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo	The default value is CultureInfo.CurrentUICulture

CustomView

Gets or sets the CustomView of SfNumericUpDown control.

Declaration

public View CustomView { get; set; }

Property Value

Type
Xamarin.Forms.View

DecrementButtonSettings

Gets or sets the properties of UpDownButtonSettings class that contains all the customization.

Declaration

public UpDownButtonSettings DecrementButtonSettings { get; set; }

Property Value

Type	Description
UpDownButtonSettings	The sfratingSettings properties.

DecrementButtonView

Gets or sets DecrementButtonView

Declaration

public View DecrementButtonView { get; set; }

Property Value

Type
Xamarin.Forms.View

EnableGroupSeparator

Gets or sets a value indicating whether EnableGroupSeparator value is allowed in SfNumericUpDown control.

Declaration

public bool EnableGroupSeparator { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

Font

Gets or sets the font for the text of the input field.

Declaration

public Font Font { get; set; }

Property Value

Type	Description
Xamarin.Forms.Font	The default value is 16.

FontAttribute

Gets or sets the font attributes for the text of the input field.

Declaration

public FontAttributes FontAttribute { get; set; }

Property Value

Type	Description
Xamarin.Forms.FontAttributes	The default value is Xamarin.Forms.FontAttributes.None

FontFamily

Gets or sets the font family for the text of the input field.

Declaration

public string FontFamily { get; set; }

Property Value

Type
System.String

FontSize

Gets or sets the value of text size.

Declaration

public double FontSize { get; set; }

Property Value

Type	Description
System.Double	The default value is 20

FormatString

Gets or sets the value that determines the display format of the text when the control is unfocused.

Declaration

public string FormatString { get; set; }

Property Value

Type	Description
System.String	The default value is 'n'

IncrementButtonSettings

Gets or sets the properties of IncrementButtonSettings class that contains all the customization.

Declaration

public UpDownButtonSettings IncrementButtonSettings { get; set; }

Property Value

Type	Description
UpDownButtonSettings	The sfratingSettings properties.

IncrementButtonView

Gets or sets IncrementButtonView

Declaration

public View IncrementButtonView { get; set; }

Property Value

Type
Xamarin.Forms.View

IsEditable

Gets or sets a value indicating whether that restrict or allow the user to perform edition operation in input field.

Declaration

public bool IsEditable { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

Maximum

Gets or sets the value that determines the maximum value of the increment.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double	The default value is 100.

MaximumDecimalDigits

Gets or sets the value of determines the maximum number of decimal digits to be allowed.

Declaration

public int MaximumDecimalDigits { get; set; }

Property Value

Type	Description
System.Int32	The default value is 2.

Minimum

Gets or sets the value that determines the minimum value of the decrement.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.

ParsingMode

Gets or sets the parser mode that parses the entered text in specified mode.

Declaration

public ParsingMode ParsingMode { get; set; }

Property Value

Type	Description
ParsingMode	The default value is Decimal.

PercentDisplayMode

Gets or sets the value that display the value either as actual value or computed with percentage.

Declaration

public PercentDisplayMode PercentDisplayMode { get; set; }

Property Value

Type	Description
PercentDisplayMode	The default value is Compute.

SelectAllOnFocus

Gets or sets a value indicating whether to enable or disable the SelectAllOnFocus property.

Declaration

public bool SelectAllOnFocus { get; set; }

Property Value

Type	Description
System.Boolean	true if enable group separator; otherwise, false.

SpinButtonAlignment

Gets or sets the value that places the increment or decrement button in left, right or both side.

Declaration

public SpinButtonAlignment SpinButtonAlignment { get; set; }

Property Value

Type	Description
SpinButtonAlignment	The default value is Right.

SpinValidation

Gets or sets the SpinValidation value

Declaration

public SpinValidation SpinValidation { get; set; }

Property Value

Type	Description
SpinValidation	The default value is Default.

StepValue

Gets or sets the value that determine the next increment and decrement value.

Declaration

public double StepValue { get; set; }

Property Value

Type	Description
System.Double	The default value is 1.

TextAlignment

Gets or sets the value that determines the alignment of the text of the input field.

Declaration

public TextAlignment TextAlignment { get; set; }

Property Value

Type	Description
Xamarin.Forms.TextAlignment	The default value is Xamarin.Forms.TextAlignment.Start.

TextColor

Gets or sets the color of text of the input field.

Declaration

public Color TextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Red

UpDownButtonColor

Gets or sets the updown button color of SfNumericUpDown control.

Declaration

public Color UpDownButtonColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Red

Value

Gets or sets the value of the input field.

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object	The default value is 0.

ValueChangeMode

Gets or sets the value that determines value change action either while every character changed or lost focus.

Declaration

public ValueChangeMode ValueChangeMode { get; set; }

Property Value

Type	Description
ValueChangeMode	The default value is OnLostFocus.

Watermark

Gets or sets the value to display hint text when the input field is empty and unfocused.

Declaration

public string Watermark { get; set; }

Property Value

Type	Description
System.String	The default value is false.

WatermarkColor

Gets or sets the color of hint text of the input field.

Declaration

public Color WatermarkColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Gray

Methods

add_FocusChanged(SfNumericUpDown.FocusEventHandler)

Declaration

public void add_FocusChanged(SfNumericUpDown.FocusEventHandler value)

Parameters

Type	Name	Description
SfNumericUpDown.FocusEventHandler	value

add_ValueChanged(SfNumericUpDown.ValueEventHandler)

Declaration

public void add_ValueChanged(SfNumericUpDown.ValueEventHandler value)

Parameters

Type	Name	Description
SfNumericUpDown.ValueEventHandler	value

OnSizeRequest(Double, Double)

Override method of on size request.

Declaration

protected override SizeRequest OnSizeRequest(double widthConstraint, double heightConstraint)

Parameters

Type	Name	Description
System.Double	widthConstraint	The width constraint.
System.Double	heightConstraint	The height constraint.

Returns

Type	Description
Xamarin.Forms.SizeRequest	The requiered size.

remove_FocusChanged(SfNumericUpDown.FocusEventHandler)

Declaration

public void remove_FocusChanged(SfNumericUpDown.FocusEventHandler value)

Parameters

Type	Name	Description
SfNumericUpDown.FocusEventHandler	value

remove_ValueChanged(SfNumericUpDown.ValueEventHandler)

Declaration

public void remove_ValueChanged(SfNumericUpDown.ValueEventHandler value)

Parameters

Type	Name	Description
SfNumericUpDown.ValueEventHandler	value

Events

Completed

Invoked when return key pressed Completed.

Declaration

public event EventHandler Completed

Event Type

Type
System.EventHandler

FocusChanged

Occurs when FocusChanged.

Declaration

public event SfNumericUpDown.FocusEventHandler FocusChanged

Event Type

Type
SfNumericUpDown.FocusEventHandler

ValueChanged

Occurs when Value is changed.

Declaration

public event SfNumericUpDown.ValueEventHandler ValueChanged

Event Type

Type
SfNumericUpDown.ValueEventHandler

ValueChanging

Occurs when Value is changing.

Declaration

public event EventHandler<ValueChangingEventArgs> ValueChanging

Event Type

Type
System.EventHandler<ValueChangingEventArgs>