Interface IMask

Namespace

MudBlazor

Assembly

MudBlazor.dll

public interface IMask

Extension Methods

ObjectExtensions.As<T>(object?)

Properties

CaretPos

The current caret position

int CaretPos { get; set; }

Property Value

int

Mask

The mask defining the structure of the accepted input. Its format depends on the implementation.

string Mask { get; }

Property Value

string

Selection

The currently selected sub-section of the Text

(int, int)? Selection { get; set; }

Property Value

(int, int)?

Text

The current text as it is displayed in the component

string Text { get; }

Property Value

string

Methods

Backspace()

Implements the effect of the Backspace key at the current cursor position

void Backspace()

Clear()

Reset the mask as if the whole textfield was cleared

void Clear()

Delete()

Implements the effect of the Del key at the current cursor position

void Delete()

GetCleanText()

Get the Text without delimiters or placeholders. Depends on the implementation entirely. Clean text will usually be used for the Value property of a mask field.

string GetCleanText()

Returns

string

Insert(string)

Implements user input at the current caret position (single key strokes or pasting longer text)

void Insert(string input)

Parameters

input string

SetText(string)

Overwrite the mask text without losing caret position

void SetText(string text)

Parameters

text string

UpdateFrom(IMask)

Copy config from other mask but preserve own state.

void UpdateFrom(IMask other)

Parameters

other IMask