IMaskedInputSettings.Mask Property

Specifies a mask pattern.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(null)]
[Parameter]
string Mask { get; set; }

Property Value

Type	Default	Description
String	null	A mask pattern string.

Remarks

The masked input editor supports the following mask types:

• Date-Time
• Date-Time Offset
• Time Span
• Numeric
• Text
• Regular Expression

Refer to the following topic for more information: Apply a Mask.

Use the Mask property to specify the mask at runtime. To set the mask in markup, use the DxMaskedInputSettings.Mask property.

The IMaskedInputSettings interface allows you to get and customize settings of a masked input editor at runtime. You can get editor settings in the following ways:

• Call the GetColumnEditSettings method to get editor settings of the column bound to the specified data source field.

  Important

  You need to enclose your code between BeginUpdate and EndUpdate method calls to change values of Grid component parameters outside the Grid component markup. Otherwise, an exception occurs.

  var maskedInputSettings = e.Grid.GetColumnEditSettings<IMaskedInputSettings>("Email");
  if(maskedInputSettings != null) {
      e.Grid.BeginUpdate();
      maskedInputSettings.Mask = "(\w|[.-])+@(\w|-)+.(\w|-){2,4}";
      e.Grid.EndUpdate();
  }
  

• Handle the CustomizeFilterRowEditor event to customize a cell editor in the filter row.

  void Grid_CustomizeFilterRowEditor(GridCustomizeFilterRowEditorEventArgs e) {
      if(e.EditSettings is IMaskedInputSettings maskedInputSettings)
          maskedInputSettings.Mask = "(\w|[.-])+@(\w|-)+.(\w|-){2,4}";
  }
  

• Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is IMaskedInputSettings maskedInputSettings)
          maskedInputSettings.Mask = "(\w|[.-])+@(\w|-)+.(\w|-){2,4}";
  }