Class SfNumericTextBox<TValue>

The NumericTextBox is used to get the number inputs from the user. The input values can be incremented or decremented by a predefined step value.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfNumericTextBox<TValue>

Namespace: Syncfusion.Blazor.Inputs

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfNumericTextBox<TValue> : SfBaseComponent, IInputBase

Type Parameters

Name	Description
TValue

Constructors

SfNumericTextBox()

Declaration

public SfNumericTextBox()

Properties

CssClass

Specifies the CSS class name that can be appended with the root element of the NumericTextBox. One or more custom CSS classes can be added to a NumericTextBox.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

Currency

Specifies the currency code to use in currency formatting. Possible values are the ISO 4217 currency codes, such as 'USD' for the US dollar and 'EUR' for the euro.

Declaration

public string Currency { get; set; }

Property Value

Type	Description
System.String

Decimals

Specifies the number precision applied to the textbox value when the NumericTextBox is focused.

Declaration

public Nullable<int> Decimals { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Enabled

Specifies a boolean value that indicates whether the NumericTextBox allows the user to interact with it.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Enable or disable persisting NumericTextBox state between page reloads. If enabled, the Value state will be persisted.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

FloatLabelType

Specifies the floating label behavior of the NumericTextBox that the placeholder text floats above the NumericTextBox based on the below values.

Possible values are:

• NeverNever floats the label in the NumericTextBox when the placeholder is available.
• AlwaysThe floating label always floats above the NumericTextBox.
• AutoThe floating label floats above the NumericTextBox after focusing it or when enters the value in it.

Declaration

public FloatLabelType FloatLabelType { get; set; }

Property Value

Type	Description
FloatLabelType

Format

Specifies the number format that indicates the display format for the value of the NumericTextBox.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String

HtmlAttributes

You can add the additional html attributes such as styles, class, and more to the root element.

If you configured both property and equivalent html attributes, then the component considers the property value.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Specifies the id of the NumericTextBox component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

InputAttributes

You can add the additional input attributes such as disabled, value, and more to the root element.

If you configured both property and equivalent input attribute, then the component considers the property value.

Declaration

public Dictionary<string, object> InputAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

Locale

Specifies the global culture and localization of the NumericTextBox component.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Max

Specifies a maximum value that is allowed a user can enter.

Declaration

public TValue Max { get; set; }

Property Value

Type	Description
TValue

Min

Specifies a minimum value that is allowed a user can enter.

Declaration

public TValue Min { get; set; }

Property Value

Type	Description
TValue

NumericEditContext

Declaration

protected EditContext NumericEditContext { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.Forms.EditContext

NumericTextBoxParent

Declaration

protected dynamic NumericTextBoxParent { get; set; }

Property Value

Type	Description
System.Object

Placeholder

Specifies the text that is shown as a hint or placeholder until the user focuses or enter a value in TextBox. The property is depending on the FloatLabelType property.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String

Readonly

Specifies the boolean value whether the NumericTextBox allows user to change the text.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean

ShowClearButton

Specifies a boolean value that indicates whether the clear button is displayed in NumericTextBox.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean

ShowSpinButton

Specifies whether the up and down spin buttons will be displayed in NumericTextBox.

Declaration

public bool ShowSpinButton { get; set; }

Property Value

Type	Description
System.Boolean

Step

Specifies the incremental or decremental step size for the NumericTextBox.

Declaration

public TValue Step { get; set; }

Property Value

Type	Description
TValue

StrictMode

Specifies a value that indicates whether the NumericTextBox component allows the value for the specified range.

True - the input value will be restricted between the min and max range. The typed value gets modified to fit the range on a focused out state.

Else, it allows any value even out of range value, at that time of wrong value entered, the error class will be added to the component to highlight the error.

Declaration

public bool StrictMode { get; set; }

Property Value

Type	Description
System.Boolean

TabIndex

Specifies the tab order of the NumericTextBox component.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32

ValidateDecimalOnType

Specifies whether the length of the decimal should be restricted during typing.

Declaration

public bool ValidateDecimalOnType { get; set; }

Property Value

Type	Description
System.Boolean

Value

Sets the value of the NumericTextBox.

Declaration

public TValue Value { get; set; }

Property Value

Type	Description
TValue

ValueChanged

Specifies the callback to trigger when the value changes.

Declaration

public EventCallback<TValue> ValueChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TValue>

ValueExpression

Specifies the expression for defining the value of the bound.

Declaration

public Expression<Func<TValue>> ValueExpression { get; set; }

Property Value

Type	Description
System.Linq.Expressions.Expression<System.Func<TValue>>

Width

Specifies the width of the NumericTextBox component.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Decrement(TValue)

Decrements the NumericTextBox value with specified step value.

Specifies the value used to decrement the NumericTextBox value. If its not given then numeric value will be decremented based on the step property value.

Declaration

public Task Decrement(TValue step)

Parameters

Type	Name	Description
TValue	step

Returns

Type	Description
System.Threading.Tasks.Task

FocusIn()

Sets the focus to the NumericTextBox component for interaction.

Declaration

public Task FocusIn()

Returns

Type	Description
System.Threading.Tasks.Task

FocusOut()

Remove the focus from the NumericTextBox component, if the component is in focus state.

Declaration

public Task FocusOut()

Returns

Type	Description
System.Threading.Tasks.Task

GetPersistData()

Gets the properties to be maintained in the persisted state.

Declaration

public Task<string> GetPersistData()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetText()

Returns the value of NumericTextBox with the format applied to the NumericTextBox.

Declaration

public string GetText()

Returns

Type	Description
System.String

Increment(TValue)

Increments the NumericTextBox value with the specified step value.

Specifies the value used to increment the NumericTextBox value.if its not given then numeric value will be incremented based on the step property value.

Declaration

public Task Increment(TValue step)

Parameters

Type	Name	Description
TValue	step

Returns

Type	Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task