IMaskedInputSettings.MaskMode Property

Specifies a mask mode.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(MaskMode.Auto)]
[Parameter]
MaskMode MaskMode { get; set; }

Property Value

Type	Default	Description
MaskMode	Auto	An enumeration value.

Available values:

Name	Description
Auto	The component activates a mask type based on the Value data type.
Numeric	The component activates the Numeric mask type.
DateTime	The component activates the Date-time mask type.
RegEx	The component activates the Regular Expression mask type.
Text	The component activates the Text mask type.
DateTimeOffset	The component activates the Date-time Offset mask type.
TimeSpan	The component activates the Time Span mask type.
DateOnly	The component activates the DateOnly mask type.
TimeOnly	The component activates the TimeOnly mask type.

Remarks

The masked input editor activates a mask type based on the column data type. For instance, if you bind the column to a DateTime object, the editor activates the date-time mask type.

Use the MaskMode property to change the mask mode at runtime. To specify the mask mode in markup, use the DxMaskedInput.MaskMode property.

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

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 spinEditSettings = e.Grid.GetColumnEditSettings<IMaskedInputSettings>("Email");
  if(spinEditSettings != null) {
      e.Grid.BeginUpdate();
      spinEditSettings.MaskMode = MaskMode.RegEx;
      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 spinEditSettings)
          spinEditSettings.MaskMode = MaskMode.RegEx;
  }
  

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

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is IMaskedInputSettings spinEditSettings)
          spinEditSettings.MaskMode = MaskMode.RegEx;
  }