Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

ICheckBoxSettings.IndeterminateDisplayText Property

Specifies the display text string that corresponds to the checkbox editor’s indeterminate state.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.2.dll

NuGet Package: DevExpress.Blazor

#Declaration

C#
[DefaultValue(null)]
[Parameter]
string IndeterminateDisplayText { get; set; }

#Property Value

Type Default Description
String null

A text string.

#Remarks

Use the IndeterminateDisplayText property to change the display text string that corresponds to the indeterminate state at runtime. To specify the display text in markup, use the DxCheckBoxSettings.IndeterminateDisplayText property.

The Grid displays this string in the following UI elements:

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.

    C#
    var checkboxSettings = e.Grid.GetColumnEditSettings<ICheckBoxSettings>("Discontinued");
    if(checkboxSettings != null) {
        e.Grid.BeginUpdate();
        checkboxSettings.IndeterminateDisplayText = "Unknown";
        e.Grid.EndUpdate();
    }
    
  • Handle the CustomizeFilterRowEditor event to customize a cell editor in the filter row.
    C#
    void Grid_CustomizeFilterRowEditor(GridCustomizeFilterRowEditorEventArgs e) {
        if(e.EditSettings is ICheckBoxSettings checkboxSettings)
            checkboxSettings.IndeterminateDisplayText = "Unknown";
    }
    
  • Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.
    C#
    void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
        if(e.EditSettings is ICheckBoxSettings checkboxSettings)
            checkboxSettings.IndeterminateDisplayText = "Unknown";
    }
    
See Also