Table of Contents

Class MudNumericField<T>

Namespace
MudBlazor
Assembly
MudBlazor.dll

A field for numeric values from users.

public class MudNumericField<T> : MudDebouncedInput<T>, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IFormComponent, IAsyncDisposable

Type Parameters

T

The type of number being collected.

Inheritance
MudNumericField<T>
Implements
Inherited Members
Extension Methods

Constructors

MudNumericField() 

public MudNumericField()

Properties

Classname 

protected string Classname { get; }

Property Value

string

ClearIcon

The icon of the clear button when Clearable is true.

[Parameter]
[Category("Appearance")]
public string ClearIcon { get; set; }

Property Value

string

Remarks

Defaults to Clear.

Clearable

Shows a button to clear the value.

[Parameter]
[Category("Behavior")]
public bool Clearable { get; set; }

Property Value

bool

HideSpinButtons

Hides the up and down buttons.

[Parameter]
[Category("Appearance")]
public bool HideSpinButtons { get; set; }

Property Value

bool

Remarks

Defaults to false. When false, the user can still change values with the keyboard arrows and by typing values.

InputMode

The type of value collected by this field.

[Parameter]
public override InputMode InputMode { get; set; }

Property Value

InputMode

Remarks

Defaults to numeric.

InvertMouseWheel

Reverses the mouse wheel direction.

[Parameter]
[Category("Behavior")]
public bool InvertMouseWheel { get; set; }

Property Value

bool

Remarks

Defaults to false.
When true, moving the mouse wheel up will decrease the value, and down will increase the value.

Max

The maximum allowed value.

[Parameter]
[Category("Validation")]
public T? Max { get; set; }

Property Value

T

Remarks

Defaults to the maximum value of the numeric type, such as MaxValue.

Min

The minimum allowed value.

[Parameter]
[Category("Validation")]
public T? Min { get; set; }

Property Value

T

Remarks

Defaults to the minimum value of the numeric type, such as MinValue.

Pattern

The regular expression used to constrain values.

[Parameter]
public override string? Pattern { get; set; }

Property Value

string

Remarks

Defaults to null, which will show a numerical keyboard on Safari. Must be a valid JavaScript regular expression. To allow only numbers (with no signs or commas), you can use [0-9.].

Step

The amount added or subtracted when changing values.

[Parameter]
[Category("Behavior")]
public T? Step { get; set; }

Property Value

T

Remarks

Defaults to 1.
This affects changing values via spin buttons or the keyboard.

Methods

BlurAsync()

When overridden, releases focus from this input.

public override ValueTask BlurAsync()

Returns

ValueTask

A ValueTask object.

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ConstrainBoundaries(T?)

Checks if the value respects the boundaries set for this instance.

protected (T? value, bool changed) ConstrainBoundaries(T? value)

Parameters

value T

Value to check.

Returns

(T value, bool changed)

Returns a valid value and if it has been changed.

Decrement()

Decreases the current value by Step.

public Task Decrement()

Returns

Task

DisposeAsyncCore()

Called to dispose this instance.

protected override ValueTask DisposeAsyncCore()

Returns

ValueTask

FocusAsync()

When overridden, obtains focus for this input.

public override ValueTask FocusAsync()

Returns

ValueTask

A ValueTask object.

HandleKeyDownAsync(KeyboardEventArgs) 

protected Task HandleKeyDownAsync(KeyboardEventArgs obj)

Parameters

obj KeyboardEventArgs

Returns

Task

HandleKeyUpAsync(KeyboardEventArgs) 

protected Task HandleKeyUpAsync(KeyboardEventArgs obj)

Parameters

obj KeyboardEventArgs

Returns

Task

Increment()

Increases the current value by Step.

public Task Increment()

Returns

Task

OnAfterRenderAsync(bool) 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnBlurredAsync(FocusEventArgs) 

protected override Task OnBlurredAsync(FocusEventArgs obj)

Parameters

obj FocusEventArgs

Returns

Task

OnMouseWheelAsync(WheelEventArgs) 

protected Task OnMouseWheelAsync(WheelEventArgs obj)

Parameters

obj WheelEventArgs

Returns

Task

SelectAsync()

When overridden, selects this input.

public override ValueTask SelectAsync()

Returns

ValueTask

A ValueTask object.

SelectRangeAsync(int, int)

When overridden, selects a portion of the input.

public override ValueTask SelectRangeAsync(int pos1, int pos2)

Parameters

pos1 int

The index of the first character to select.

pos2 int

The index of the last character to select.

Returns

ValueTask

A ValueTask object.

SetValueAsync(T?, bool, bool) 

protected override Task SetValueAsync(T? value, bool updateText = true, bool force = false)

Parameters

value T
updateText bool
force bool

Returns

Task

ValidateInput(T?) 

protected Task<bool> ValidateInput(T? value)

Parameters

value T

Returns

Task<bool>