Table of Contents

Class MudTextField<T>

Namespace
MudBlazor
Assembly
MudBlazor.dll
public class MudTextField<T> : MudDebouncedInput<T>, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IFormComponent, IDisposable

Type Parameters

T
Inheritance
MudTextField<T>
Implements
Inherited Members
Extension Methods

Constructors

MudTextField() 

public MudTextField()

Properties

AutoGrow

If true the input element will grow automatically with the text.

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

Property Value

bool

Classname 

protected string Classname { get; }

Property Value

string

ClearIcon

Custom clear icon when Clearable is enabled.

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

Property Value

string

Clearable

Show clear button.

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

Property Value

bool

InputReference 

public MudInput<string> InputReference { get; }

Property Value

MudInput<string>

InputType

Type of the input element. It should be a valid HTML5 input type.

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

Property Value

InputType

Mask

Provide a masking object. Built-in masks are PatternMask, MultiMask, RegexMask and BlockMask Note: when Mask is set, TextField will ignore some properties such as Lines, Pattern or HideSpinButtons, OnKeyDown and OnKeyUp, etc.

[Parameter]
[Category("Data")]
public IMask Mask { get; set; }

Property Value

IMask

MaxLines

If AutoGrow is set to true, the input element will not grow bigger than MaxLines lines. If MaxLines is set to 0 or less, the property will be ignored.

[Parameter]
[Category("Behavior")]
public int MaxLines { get; set; }

Property Value

int

OnClearButtonClick

Button click event for clear button. Called after text and value has been cleared.

[Parameter]
public EventCallback<MouseEventArgs> OnClearButtonClick { get; set; }

Property Value

EventCallback<MouseEventArgs>

Methods

BlurAsync() 

public override ValueTask BlurAsync()

Returns

ValueTask

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

Clear()

Clear the text field, set Value to default(T) and Text to null

public Task Clear()

Returns

Task

FocusAsync() 

public override ValueTask FocusAsync()

Returns

ValueTask

ResetValueAsync() 

protected override Task ResetValueAsync()

Returns

Task

SelectAsync() 

public override ValueTask SelectAsync()

Returns

ValueTask

SelectRangeAsync(int, int) 

public override ValueTask SelectRangeAsync(int pos1, int pos2)

Parameters

pos1 int
pos2 int

Returns

ValueTask

SetText(string)

Sets the input text from outside programmatically

public Task SetText(string text)

Parameters

text string

Returns

Task

SetTextAsync(string, bool) 

protected override Task SetTextAsync(string text, bool updateValue = true)

Parameters

text string
updateValue bool

Returns

Task

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