Skip to main content
All docs
V25.1
  • ICheckBoxSettings.CheckedDisplayText Property

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

    Namespace: DevExpress.Blazor

    Assembly: DevExpress.Blazor.v25.1.dll

    NuGet Package: DevExpress.Blazor

    Declaration

    [DefaultValue(null)]
    [Parameter]
    string CheckedDisplayText { get; set; }

    Property Value

    Type Default Description
    String null

    A text string.

    Remarks

    Use the CheckedDisplayText property to change the display text string that corresponds to the checked state at runtime. To specify the display text in markup, use the DxCheckBoxSettings.CheckedDisplayText 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.

      var checkboxSettings = e.Grid.GetColumnEditSettings<ICheckBoxSettings>("Discontinued");
      if(checkboxSettings != null) {
          e.Grid.BeginUpdate();
          checkboxSettings.CheckedDisplayText = "Yes";
          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.CheckedDisplayText = "Yes";
      }
      
    • 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.CheckedDisplayText = "Yes";
      }
      
    See Also