Class IgbMaskInput

A masked input is an input field where a developer can control user input and format the visible value, based on configurable rules

Inheritance
System.Object
BaseRendererControl
IgbInputBase
IgbMaskInputBase
IgbMaskInput
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbMaskInput : IgbMaskInputBase, RefSink, JsonSerializable, IDisposable

Constructors

IgbMaskInput()

Declaration
public IgbMaskInput()

Properties

Change

Declaration
public EventCallback<IgbComponentValueChangedEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbComponentValueChangedEventArgs>

ChangeScript

Declaration
public string ChangeScript { get; set; }
Property Value
Type Description
System.String

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Value

The value of the input. Regardless of the currently set value-mode, an empty value will return an empty string.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String

ValueChanged

Declaration
public EventCallback<string> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.String>

ValueMode

Dictates the behavior when retrieving the value of the control:

  • raw: Returns clean input (e.g. "5551234567")
  • withFormatting: Returns with mask formatting (e.g. "(555) 123-4567") Empty values always return an empty string, regardless of the value mode. @default 'raw'
Declaration
public MaskInputValueMode ValueMode { get; set; }
Property Value
Type Description
MaskInputValueMode

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetCurrentValue()

Declaration
public string GetCurrentValue()
Returns
Type Description
System.String

GetCurrentValueAsync()

Declaration
public Task<string> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

Implements

System.IDisposable