ICheckBoxSettings.ShowCheckBoxInDisplayMode Property

Specifies whether to display column cell values as checkboxes or text strings when the Grid is in display mode.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.1.dll

NuGet Package: DevExpress.Blazor

Declaration

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

Property Value

Type	Default	Description
Boolean	true	true to display cell values as checkboxes; false to display cell values as text strings.

Remarks

The Grid component generates and configures cell editors for individual columns based on associated data types. The component displays these cell editors in the filter row and in data rows during edit operations. If a column’s cell editor is a checkbox, the Grid also displays column cell values as checkboxes in display mode.

Use the ShowCheckBoxInDisplayMode property to change display mode of column cells at runtime. To specify the display mode in markup, use the DxCheckBoxSettings.ShowCheckBoxInDisplayMode property.

The ICheckBoxSettings interface allows you to get and customize settings of a checkbox 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 checkboxSettings = e.Grid.GetColumnEditSettings<ICheckBoxSettings>("Discontinued");
  if(checkboxSettings != null) {
      e.Grid.BeginUpdate();
      checkboxSettings.ShowCheckBoxInDisplayMode = 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 ICheckBoxSettings checkboxSettings)
          checkboxSettings.ShowCheckBoxInDisplayMode = false;
  }
  

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

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is ICheckBoxSettings checkboxSettings)
          checkboxSettings.ShowCheckBoxInDisplayMode = false;
  }