ICheckBoxSettings.CheckType Property

Specifies the type of the displayed checkbox editor when the Grid is in edit mode.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(CheckType.Checkbox)]
[Parameter]
CheckType CheckType { get; set; }

Property Value

Type	Default	Description
CheckType	Checkbox	An enumeration value.

Available values:

Name	Description
Checkbox	A standard checkbox.
Switch	A toggle switch.

Remarks

Use the CheckType property to change the checkbox type (checkbox or switch) at runtime. In markup, set the DxCheckBoxSettings.CheckType property to Switch to display the checkbox editor as a toggle switch.

Note

The CheckType property does not affect checkboxes displayed in data cells when the Grid is in display mode.

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.CheckType = CheckType.Switch;
      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.CheckType = CheckType.Switch;
  }
  

• 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.CheckType = CheckType.Switch;
  }