ICheckBoxSettings.AllowIndeterminateStateByClick Property

Specifies whether a click on the checkbox editor can switch it to the indeterminate state.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(false)]
[Parameter]
bool AllowIndeterminateStateByClick { get; set; }

Property Value

Type	Default	Description
Boolean	false	true if a click on the checkbox can switch it to the indeterminate state; otherwise, false.

Remarks

Use the AllowIndeterminateStateByClick property to allow/prohibit users to/from switching the checkbox to the indeterminate state at runtime.

In markup, set the DxCheckBoxSettings.AllowIndeterminateStateByClick property to true to allow users to select the indeterminate state.

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.AllowIndeterminateStateByClick = 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 ICheckBoxSettings checkboxSettings)
          checkboxSettings.AllowIndeterminateStateByClick = true;
  }
  

• 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.AllowIndeterminateStateByClick = true;
  }