Skip to main content
All docs
V25.1
  • DxCheckBoxSettings.UncheckedDisplayText Property

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

    Namespace: DevExpress.Blazor

    Assembly: DevExpress.Blazor.v25.1.dll

    NuGet Package: DevExpress.Blazor

    Declaration

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

    Property Value

    Type Default Description
    String null

    A text string.

    Remarks

    Specify the UncheckedDisplayText property to change the display text string that corresponds to the checkbox editor’s unchecked state. Grid and TreeList display this string in the following UI elements:

    • Filter row
    • Column filter menu
    • Column cells, if the ShowCheckBoxInDisplayMode property is set to false and the component is in display mode

    The following code snippet displays custom strings in the Discontinued column:

    Check Box Setting

    @inject ProductService ProductData
    
    <DxGrid Data="@products">
        <Columns>
            <DxGridDataColumn FieldName="ProductName" />
            <DxGridDataColumn FieldName="UnitPrice" />
            <DxGridDataColumn FieldName="UnitsInOrder" />
            <DxGridDataColumn FieldName="Discontinued">
                <EditSettings>
                    <DxCheckBoxSettings ShowCheckBoxInDisplayMode="false"
                                        CheckedDisplayText="Yes"
                                        IndeterminateDisplayText="Unknown"
                                        UncheckedDisplayText="No" />
                </EditSettings>
            </DxGridDataColumn>
        </Columns>
    </DxGrid>
    
    @code {
        private Product[]? products;
        protected override async Task OnInitializedAsync() {
            products = await ProductData.GetData();
        }
    }
    

    To change the display text string that corresponds to the unchecked state at runtime, use the ICheckBoxSettings.UncheckedDisplayText property.

    See Also