SearchControl Class

A search control.

Assembly: DevExpress.Xpf.Core.v18.2.dll

Declaration

C#
VB.NET

public class SearchControl :
    Control

Public Class SearchControl
    Inherits Control

The following members return SearchControl objects:

Remarks

A Search Control delivers an easy and straightforward way for end-users to locate information within data editors (list boxes, combo boxes, etc). To execute a search, enter the text in the Find box and data editors linked 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.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-locate-information-within-listboxedit-using-the-search-control-e3990.

<Window x:Class="ListBoxFilteringUsingSearchPanel.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525"
        xmlns:sys="clr-namespace:System;assembly=mscorlib"
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition/>
            <RowDefinition/>
        </Grid.RowDefinitions>
        <dxe:SearchControl x:Name="searchControl" Grid.Row="0" Margin="10"
                           HorizontalAlignment="Stretch" VerticalAlignment="Center"
                           FilterCondition="Contains"
                           FilterByColumnsMode="Custom"
                           >
            <dxe:SearchControl.ColumnProvider>
                <dxe:SelectorEditColumnProvider>
                    <dxe:SelectorEditColumnProvider.CustomColumns>
                        <sys:String>Name</sys:String>
                    </dxe:SelectorEditColumnProvider.CustomColumns>
                </dxe:SelectorEditColumnProvider>
            </dxe:SearchControl.ColumnProvider>
        </dxe:SearchControl>

        <dxe:ListBoxEdit Name="listBox" Grid.Row="1"  Margin="10"
                         HorizontalAlignment="Stretch" VerticalAlignment="Stretch"
                         DisplayMember="Name" ValueMember="ID"
                         FilterCriteria="{Binding FilterCriteria, ElementName=searchControl}">

        </dxe:ListBoxEdit>
    </Grid>
</Window>

using System.Windows;

namespace ListBoxFilteringUsingSearchPanel {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            listBox.ItemsSource = Stuff.GetStuff();
        }
    }
}

Imports Microsoft.VisualBasic
Imports System.Windows

Namespace ListBoxFilteringUsingSearchPanel
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            listBox.ItemsSource = Stuff.GetStuff()
        End Sub
    End Class
End Namespace

The following code snippets (auto-collected from DevExpress Examples) contain references to the SearchControl class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

how-to-show-the-appointments-search-result-in-searchresult-view-for-schedulercontrol-simil-t278605/VB/SearchResultViewDemo/MainWindow.xaml#L147

</Grid.RowDefinitions>
<dxe:SearchControl x:Name="SearchControl" Margin="10"
           VerticalAlignment="Center"

how-to-locate-information-within-listboxedit-using-the-search-control-e3990/VB/ListBoxFilteringUsingSearchPanel/MainWindow.xaml#L12

</Grid.RowDefinitions>
<dxe:SearchControl x:Name="searchControl" Grid.Row="0" Margin="10"
                   HorizontalAlignment="Stretch" VerticalAlignment="Center"