ITextBoxSettings Interface

Defines settings of a text box editor.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

public interface ITextBoxSettings :
    IButtonEditSettings,
    ITextEditSettings,
    IEditSettings

Remarks

The ITextBoxSettings interface allows you to get and customize settings of a text box 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 firstNameSettings = e.Grid.GetColumnEditSettings<ITextBoxSettings>("FirstName");
  if(firstNameSettings != null) {
      e.Grid.BeginUpdate();
      firstNameSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto;
      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 ITextBoxSettings firstNameSettings)
          firstNameSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto;
  }
  

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

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is ITextBoxSettings firstNameSettings)
          firstNameSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto;
  }