IMaskedInputSettings Interface

Declares masked input settings.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v26.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public interface IMaskedInputSettings :
    IButtonEditSettings,
    ITextEditSettings,
    IEditSettings

Remarks

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.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 maskedInputSettings)
          maskedInputSettings.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 maskedInputSettings)
          maskedInputSettings.MaskMode = MaskMode.RegEx;
  }
  

The IMaskedInputSettings class is inherited from IEditSettings, IButtonEditSettings, and ITextEditSettings interfaces and includes all APIs available in parent classes. You can use base interfaces to customize settings at runtime:

void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
    if(e.EditSettings is ITextEditSettings firstNameSettings)
        firstNameSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto;
    if(e.EditSettings is IMaskedInputSettings maskedInputSettings)
        maskedInputSettings.MaskMode = MaskMode.RegEx;
}