[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].NET Core 3 Support
 [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
   [Collapse]AutoSuggestEdit Class
     AutoSuggestEdit Members
     AutoSuggestEdit Constructor
    [Expand]AutoSuggestEdit Properties
    [Expand]AutoSuggestEdit Events
    [Expand]AutoSuggestEdit Methods
    AutoSuggestEditChangeTextReason Enumeration
   [Expand]AutoSuggestEditCustomPopupHighlightedTextEventArgs Class
   [Expand]AutoSuggestEditQuerySubmittedEventArgs Class
   [Expand]AutoSuggestEditSuggestionChoosingEventArgs 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]DateEditNavigatorStyleSettings Class
   [Expand]DateEditNavigatorWithTimePickerStyleSettings Class
   [Expand]DateEditPickerStyleSettings Class
    DateEditPopupContentType Enumeration
   [Expand]DateEditTimePickerStyleSettings 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]LoadingIndicatorButtonInfo 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
   [Expand]SearchControl Class
    SearchPanelParseMode Enumeration
    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
   [Expand]TimePicker Class
   [Expand]TimePickerDateTimeChangedEventArgs Class
    TimePickerDateTimeChangedEventHandler Delegate
    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)

AutoSuggestEdit Class

An editor that displays a drop-down list of suggestions as a user types in the text box.

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

Expanded Syntax

Expanded Remarks

The AutoSuggestEdit (see AutoSuggestEdit) is an editor that displays a drop-down list of suggestions as the user types in the text box.

Tip

The AutoSuggestEdit class inherits its features from the PopupBaseEdit class.

Refer to the PopupBaseEdit class description for information on derived features and API.

The editor is useful in the following cases:

  • Re-build the suggestion list on-the-fly

    The AutoSuggestEdit can display a dynamically populated list of suggestions. You can enable the search text highlight. You can populate the item list with any items that you consider appropriate for the entered string. With the AutoSuggestEdit, you can search against large data sources without any UI performance degradation.

  • Use advanced search

    You can control which items to display in the suggestion list. The editor allows you to populate a list of suggestions via a custom search engine, fuzzy search, remote web service, etc.

Add an AutoSuggestEdit to a Project

Editor Value

The editor's value can be specified using the BaseEdit.EditValue property or the SetEditText method.

To respond to changing the editor's value, handle the BaseEdit.EditValueChanged event. To check the new value's validity, handle the BaseEdit.Validate event.

Dynamically Loaded Suggestions

The editor fires the QuerySubmitted event when an end user types in the editor's text box. In the event handler, you can:

  • get the entered text
  • use this text to search for relevant suggestions (using search engines, fuzzy search, etc.)
  • provide suggestions for the editor to display in its drop-down list. In this case, assign a collection of suggestions to the editor's ItemsSource property.

The editor's SuggestionChoosing event occurs before the editor accepts the selected value and allows you to substitute a selected popup item with another object.

Custom Control in Editor Popup

Use the PopupBaseEdit.PopupContentTemplate property to define a custom control that displays suggestions in the AutoSuggestEdit's popup. The custom control's x:Name property should be set to "PART_Content".

If the PopupContentTemplate (see PopupBaseEdit.PopupContentTemplate) is not specified, the editor uses the DevExpress.Xpf.Editors.Popup.AutoSuggestListBox control to display a collection item list. AutoSuggestListBox is a System.Windows.Controls.ListBox descendant designed to be used in the AutoSuggestEdit's popup.

Customize Items

Appearance

You can change the AutoSuggestEdit items' appearance via WPF templates. Use the AutoSuggestEdit's ItemTemplate property to specify the item template.

You can apply different templates to an editor's drop-down items using custom logic implemented in the ItemTemplateSelector.

Content

When the editor suggestions are represented by complex objects, use the following properties:

  • DisplayMember - specifies a field name in the bound data source whose values are displayed in the editor popup.
  • TextMember - specifies a data field whose values are displayed in the editor's text box.

You can specify the ItemStringFormat property to define how to format suggestions' display text.

Item Highlight

Use the following API to highlight the search text in a list of suggestions.

Member Description
AllowPopupTextHighlighting Gets or sets whether the editor highlights the search results in its drop-down text according to the PopupHighlightedTextCriteria criteria.
PopupHighlightedTextCriteria Gets the filter condition (comparison operator) used to highlight the text in drop-down suggestions.
CustomPopupHighlightedText Occurs when an end-user types into the editor's text box and allows you to provide a custom text to highlight.

Examples

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
                      BaseEdit
                         TextEditBase
                            TextEdit
                               ButtonEdit
                                  PopupBaseEdit
                                     AutoSuggestEdit

Expanded See Also

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