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

ISearchControlProperties.ClearButtonShowMode Property

Gets or sets the way the clear button within this Search Panel is shown.

Namespace: DevExpress.XtraBars.Docking2010.Customization

Assembly: DevExpress.XtraBars.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

ClearButtonShowMode ClearButtonShowMode { get; set; }

#Property Value

Type Description
DevExpress.XtraBars.Docking2010.Customization.ClearButtonShowMode

A DevExpress.XtraBars.Docking2010.Customization.ClearButtonShowMode enumerator value that specifies the way the clear button within this Search Panel is shown.

#Remarks

A clear button within the Search Panel can be displayed differently depending on the ClearButtonShowMode property values:

  • Auto - the clear button is automatically displayed when there is text entered in the search panel. The button is not displayed if the search bar is empty.
  • AlwaysVisible - the clear button is always shown whether or not there is any text entered into the Search Panel.
  • Hidden - the clear button is always hidden.
  • ReplaceSearchButton - the default value that specifies that if there is any text entered into the search panel’s search bar, the search button is automatically replaced with the clear button. Thus, the search button is visible only if the search panel is empty.

Important

Do not set the ISearchControlProperties.FindDelay property to 0 if the ClearButtonShowMode property equals ReplaceSearchButton: since neither search button will be displayed when the text is entered, nor auto-search is enabled. This will make it impossible to search for the entered text.

See Also