IEditSettings.Enabled Property

Specifies whether an editor is enabled.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(true)]
[Parameter]
bool Enabled { get; set; }

Property Value

Type	Default	Description
Boolean	true	true if the editor is enabled; false if the editor is disabled.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Enabled
GridCustomizeCellEditorEventArgs	.EditSettings .Enabled
GridCustomizeFilterRowEditorEventArgs	.EditSettings .Enabled
TreeListCustomizeCellEditorEventArgs	.EditSettings .Enabled
TreeListCustomizeFilterRowEditorEventArgs	.EditSettings .Enabled

Remarks

When the editor is disabled, it does not respond to user interactions and users cannot change the editor’s value. In this mode, the editor cannot be focused or navigated.

Use the Enabled property disable or enable an editor at runtime. Set the DxEditSettings.Enabled property to false to disable the editor in markup.

Note that the Enabled property does not affect the editor displayed in the filter row. To hide the filter row editor, set the FilterRowEditorVisible property to false.

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.Enabled = false;
      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.Enabled = false;
  }
  

• 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.Enabled = false;
  }