IEditSettings Interface

Declares common editor settings.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

Declaration

public interface IEditSettings

Related API Members

The following members return IEditSettings objects:

• GridCustomizeDataRowEditorEventArgs.EditSettings
• GridCustomizeFilterRowEditorEventArgs.EditSettings
• TreeListCustomizeDataRowEditorEventArgs.EditSettings
• TreeListCustomizeFilterRowEditorEventArgs.EditSettings

Remarks

The IEditSettings interface allows you to get and customize editor settings. You can get editor settings in the following ways. Note that you can cast settings to the base IEditSettings interface or to an editor-specific interface.

• 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 productEditSettings = e.Grid.GetColumnEditSettings<IEditSettings>("ProductID");
  // or var productEditSettings = e.Grid.GetColumnEditSettings<ISpinEditSettings>("ProductID");
  if(productEditSettings != null) {
      e.Grid.BeginUpdate();
      productEditSettings.ReadOnly = true;
      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 IEditSettings productEditSettings)
      // or if(e.EditSettings is ISpinEditSettings productEditSettings)
          productEditSettings.ReadOnly = true;
  }
  

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

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is IEditSettings productEditSettings)
      // or if(e.EditSettings is ISpinEditSettings productEditSettings)
          productEditSettings.ReadOnly = true;
  }