Skip to main content

DxTagBox<TData, TValue>.ClearButtonDisplayMode Property

Specifies whether the TagBox displays the Clear button when it is not empty.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v22.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(DataEditorClearButtonDisplayMode.Never)]
[Parameter]
public DataEditorClearButtonDisplayMode ClearButtonDisplayMode { get; set; }

Property Value

Type Default Description
DataEditorClearButtonDisplayMode Never

A DataEditorClearButtonDisplayMode enumeration value.

Available values:

Name Description
Auto

The clear button is visible when an editor is not empty.

Never

The clear button is not visible.

Remarks

The Clear button clears the editor’s value (sets it to NULL). To display this button in the editor when there is a value in it, set the ClearButtonDisplayMode property to DataEditorClearButtonDisplayMode.Auto This mode also requires that the editor’s data type is nullable.

When users clear the editor’s value, the TagBox displays the NullText string (if specified).

<DxTagBox NullText="Select countries..."
          Data="@CountryData.Countries"
          @bind-Values="@SelectedCountries"
          TextFieldName="@nameof(Country.CountryName)"
          ClearButtonDisplayMode="DataEditorClearButtonDisplayMode.Auto" />
</DxTagBox>

@code {
    IEnumerable<Country> SelectedCountries { get; set; }
}

TagBox Clear Button

Run Demo: TagBox - Clear Button and Placeholder

See Also