[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Data
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.FilteringUI
  [Expand]DevExpress.Xpf.Core.Native
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Dialogs
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Collapse]DevExpress.Xpf.Editors
    ActivationAction Enumeration
   [Expand]AreaSparklineStyleSettings Class
    AutoCompleteType Enumeration
   [Expand]AutoSuggestEdit Class
    AutoSuggestEditChangeTextReason Enumeration
   [Expand]AutoSuggestEditCustomPopupHighlightedTextEventArgs Class
   [Expand]AutoSuggestEditQuerySubmittedEventArgs Class
   [Expand]AutoSuggestEditSuggestionChosenEventArgs Class
   [Expand]AutoSuggestEditTextChangedEventArgs Class
   [Expand]BarCodeEdit Class
   [Expand]BarCodePropertyProvider Class
   [Expand]BarSparklineStyleSettings Class
   [Expand]BaseComboBoxStyleSettings Class
   [Expand]BaseEdit Class
   [Expand]BaseEditStyleSettings Class
   [Expand]BaseProgressBarStyleSettings Class
   [Expand]ButtonEdit Class
   [Expand]ButtonInfo Class
   [Expand]ButtonInfoBase Class
   [Expand]ButtonInfoCollection Class
    ButtonKind Enumeration
   [Expand]Calculator Class
   [Expand]CalculatorCustomErrorTextEventArgs Class
    CalculatorCustomErrorTextEventHandler Delegate
   [Expand]CameraControl Class
   [Expand]CameraDevice Class
   [Expand]CheckedComboBoxStyleSettings Class
   [Expand]CheckEdit Class
   [Expand]CheckEditBox Class
    CheckEditDisplayMode Enumeration
   [Expand]CheckedListBoxEditStyleSettings Class
   [Expand]CheckedTokenComboBoxStyleSettings Class
    ChipSize Enumeration
   [Expand]ClosePopupEventArgs Class
    ClosePopupEventHandler Delegate
    ColorDisplayFormat Enumeration
   [Expand]ColorEdit Class
   [Expand]ColorPalette Class
   [Expand]ComboBoxEdit Class
   [Expand]ComboBoxEditItem Class
   [Expand]ComboBoxStyleSettings Class
    ContentDisplayMode Enumeration
   [Expand]ConvertEditValueEventArgs Class
   [Expand]CustomDisplayTextEventArgs Class
    CustomDisplayTextEventHandler Delegate
   [Expand]CustomPalette Class
   [Expand]DateEdit Class
   [Expand]DateEditCalendarStyleSettings Class
   [Expand]DateEditPickerStyleSettings Class
   [Expand]DeleteButtonInfo Class
   [Expand]EditableDataObject Class
    EditMode Enumeration
   [Expand]EditorLocalizer Class
    EditorPlacement Enumeration
    EditorStringId Enumeration
   [Expand]EditValueChangedEventArgs Class
    EditValueChangedEventHandler Delegate
   [Expand]EditValueChangingEventArgs Class
    EditValueChangingEventHandler Delegate
   [Expand]ErrorControl Class
    FindMode Enumeration
   [Expand]FontEdit Class
    GlyphKind Enumeration
    HighlightedTextCriteria Enumeration
   [Expand]HyperlinkEdit Class
   [Expand]HyperlinkEditRequestNavigationEventArgs Class
   [Expand]ImageCheckEditStyleSettings Class
   [Expand]ImageEdit Class
   [Expand]LineSparklineStyleSettings Class
   [Expand]ListBoxEdit Class
   [Expand]ListBoxEditItem Class
   [Expand]ListBoxEditStyleSettings Class
   [Expand]LookUpEditBase Class
    MaskType Enumeration
   [Expand]MemoEdit Class
    NewTokenPosition Enumeration
   [Expand]NumericMaskOptions Class
   [Expand]PagerControl Class
   [Expand]PaletteCollection Class
   [Expand]PasswordBoxEdit Class
    PasswordStrength Enumeration
   [Expand]PasswordStrengthEventArgs Class
   [Expand]PopupBaseEdit Class
   [Expand]PopupCalcEdit Class
    PopupCloseMode Enumeration
   [Expand]PopupColorEdit Class
    PopupFooterButtons Enumeration
   [Expand]PopupImageEdit Class
    PostMode Enumeration
   [Expand]PredefinedColorCollections Class
   [Expand]PredefinedPaletteCollections Class
   [Expand]ProcessNewValueEventArgs Class
    ProcessNewValueEventHandler Delegate
   [Expand]ProgressBarEdit Class
   [Expand]ProgressBarMarqueeStyleSettings Class
   [Expand]ProgressBarStyleSettings Class
   [Expand]RadioComboBoxStyleSettings Class
   [Expand]RadioListBoxEditStyleSettings Class
   [Expand]Range Class
   [Expand]RangeBaseEdit Class
   [Expand]RatingControl Class
   [Expand]RatingEdit Class
   [Expand]RatingItem Class
    RatingPrecision Enumeration
    ScrollUnit Enumeration
   [Collapse]SearchControl Class
     SearchControl Members
     SearchControl Constructor
    [Expand]SearchControl Properties
    [Expand]SearchControl Methods
    ShowLoadDialogOnClickMode Enumeration
    ShowMenuMode Enumeration
   [Expand]SparklineEdit Class
    SparklineSortOrder Enumeration
   [Expand]SparklineStyleSettings Class
    SparklineViewType Enumeration
   [Expand]SpinEdit Class
   [Expand]SpinEventArgs Class
    SpinEventHandler Delegate
    SpinStyle Enumeration
   [Expand]TextEdit Class
   [Expand]TextEditBase Class
    TimeSpanInputMode Enumeration
   [Expand]TimeSpanMaskOptions Class
    TimeSpanPart Enumeration
   [Expand]ToggleSwitch Class
    ToggleSwitchAnimationMode Enumeration
    ToggleSwitchContentPlacement Enumeration
   [Expand]ToggleSwitchEdit Class
   [Expand]TokenActivatingEventArgs Class
   [Expand]TokenComboBoxStyleSettings Class
   [Expand]TokenEditorBehavior Class
   [Expand]TokensChangedEventArgs Class
   [Expand]TokensChangingEventArgs Class
   [Expand]TokenStateChangedEventArgs Class
   [Expand]TokenTextChangingEventArgs Class
   [Expand]TrackBarEdit Class
   [Expand]TrackBarEditRange Class
    TrackBarIncrementTargetEnum Enumeration
   [Expand]TrackBarRangeStyleSettings Class
   [Expand]TrackBarStyleSettings Class
   [Expand]TrackBarZoomRangeStyleSettings Class
   [Expand]TrackBarZoomStyleSettings Class
   [Expand]ValidationEventArgs Class
   [Expand]WinLossSparklineStyleSettings Class
  [Expand]DevExpress.Xpf.Editors.DataPager
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Native
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gantt
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Common
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.iCalendar
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.Scheduling.VisualData
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Printing
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

SearchControl Class

A search control.

Namespace:DevExpress.Xpf.Editors
Assembly:DevExpress.Xpf.Core.v19.1.dll

Expanded Syntax

Expanded Remarks

The Search Control provides an easy way for end users to locate information within data editors (list boxes, combo boxes, etc). To execute a search, enter the text in the search box. Data editors bound to the Search Control will display those records that have matching values.

Various options are available to control the display and behavior of the Search Control. You can specify search columns, choose between automatic and manual search modes, optionally display control buttons, etc.

Tip

Topic: Data Grid - Search

Expanded Search Syntax

  • Single keyword.

    Sales - Selects records that contain the "Sales" string in any search column.

  • To search for a string that contains a space character, specify this string in quotation marks.

    "Sales Manager" - Selects records that contain "Sales Manager" in any search column.

  • Without quotation marks, words separated by the space character are treated as individual conditions.

    Sales Manager - Selects records that contain either "Sales" or "Manager" strings in any search column.

  • To search against a specific column, precede a search string with the column's display name plus a colon character.

    Tip

    Instead of the complete name, you can partially specify the display name using the initial characters of a column's display name. A search is performed against the first column whose display name starts with the specified substring.

    To search against a column whose display caption contains space characters, specify the column's display caption in quotation marks.

    Group:Sales - Selects records that contain "Sales" in the column that starts with "Group".

    Note

    If the search string contains multiple conditions separated by space characters, and at least one condition defines a search against a specific column, only records that match all of these conditions are shown (i.e., the conditions are combined by the And logical operator).

    If there is no column specification, records that match at least one of these conditions are shown (i.e., the conditions are combined by the Or logical operator).

    Group:Sales Manager - Selects records that contain "Sales" in the column that starts with "Group", and also contain "Manager" in any search column.

  • Precede a condition with "+" to display only records that match this condition. The "+" specifier allows you to implement the logical And operator. There should be no space character between the "+" sign and the condition.

    Sales +Specialist - Selects records that contain both "Sales" and "Specialist" in search columns.

  • Precede a condition with "-" to exclude records that match this condition from the result set. There should be no space between the "-" sign and the condition.

    Sales -Specialist - Selects records that contain "Sales" excluding records that contain "Specialist".

    Note

    If the expression contains the "-" character, quotation marks are ignored.

  • You can combine different operators.

    Sales +Representative -"United States" - Selects records that contain both "Sales" and "Representative" in search columns, excluding records that contain "United States".

Expanded Example

This example shows how to use the SearchControl to locate required items displayed within a list box. To execute a search, enter a text within the Find box, and the list box linked to the Search Control will display those records that have matching values.

Expanded Inheritance Hierarchy

System.Object
    System.Windows.Threading.DispatcherObject
       System.Windows.DependencyObject
          System.Windows.Media.Visual
             System.Windows.UIElement
                System.Windows.FrameworkElement
                   System.Windows.Controls.Control
                      SearchControl

Expanded See Also

Is this topic helpful?​​​​​​​