SearchControl.ColumnProvider Property

Gets or sets the column provider for the search control. This is a dependency property.

Namespace: DevExpress.Xpf.Editors

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core

Declaration

C#

public ISearchPanelColumnProviderBase ColumnProvider { get; set; }

VB.NET

Public Property ColumnProvider As ISearchPanelColumnProviderBase

Property Value

Type	Description
DevExpress.Xpf.Editors.ISearchPanelColumnProviderBase	An object implementing the DevExpress.Xpf.Editors.ISearchPanelColumnProviderBase interface.

Remarks

If the ColumnProvider property is not defined, the filter criteria has the following format: “StartsWith([], ‘<text>’)”.

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.

View Example

MainWindow.xaml

<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>

MainWindow.xaml.cs

using System.Windows;

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

MainWindow.xaml.vb

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ColumnProvider property.

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.

XAML

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

</dxmvvm:Interaction.Behaviors>
<dxe:SearchControl.ColumnProvider>
    <dxe:SelectorEditColumnProvider>