DxDropDownListEditorBase<TData, TValue>.SearchFilterCondition Property

Specifies the search and filter condition.

Assembly: DevExpress.Blazor.v25.2.dll

Declaration

[DefaultValue(ListSearchFilterCondition.Default)]
[Parameter]
public ListSearchFilterCondition SearchFilterCondition { get; set; }

Property Value

Type	Default	Description
ListSearchFilterCondition	Default	A ListSearchFilterCondition enumeration value.

Available values:

Name	Description
Default	The `Contains` condition is used. Filters the component for items that contain the search string. Search string matches are highlighted.
StartsWith	Filters the component for items that begin with the search string.
Contains	Filters the component for items that contain the search string. Search string matches are highlighted.
Equals	Searches for items whose value matches the search string.

Remarks

The DevExpress Blazor ComboBox and TagBox components can search for text, and filter and highlight search results. Use the following API members to enable search and filter capabilities:

SearchMode — Specifies whether the component can search for text users type in the edit box. When the AutoSearch mode is active, the ComboBox filters items based on the search string and highlights matches. All visible columns are searched.

Users can use special characters to create composite criteria. Refer to the following section for additional information: Search Syntax.
SearchFilterCondition — Specifies the search and filter condition (Contains, Equals, or StartsWith).
SearchTextParseMode — Specifies how the component combines words in the search query. If search text contains multiple words separated by space characters, words can be treated as single or individual conditions. The GroupWordsByAnd, GroupWordsByOr, and ExactMatch modes are available.
SearchEnabled - Specifies whether the component can search text in cells of the current column.

<DxComboBox Data="Staff.DataSource" 
            @bind-Value="@Value" 
            SearchMode="ListSearchMode.AutoSearch"
            SearchFilterCondition="ListSearchFilterCondition.Contains">
    <Columns>
        <DxListEditorColumn FieldName="FirstName"></DxListEditorColumn>
        <DxListEditorColumn FieldName="LastName"></DxListEditorColumn>
        <DxListEditorColumn FieldName="Department" SearchEnabled="false"></DxListEditorColumn>
    </Columns>
</DxComboBox>

@code {
    string Value { get; set; }
}

namespace StaffData {
    public static class Staff {
        private static readonly Lazy<List<Person>> dataSource = new Lazy<List<Person>>(() => {
            var dataSource = new List<Person>() {
                new Person() { Id= 0 , FirstName="John", LastName="Heart", Department=Department.Electronics },
                new Person() { Id= 1 , FirstName="Samantha", LastName="Bright", Department=Department.Motors },
                new Person() { Id= 2 , FirstName="Arthur", LastName="Miller", Department=Department.Software },
                new Person() { Id= 3 , FirstName="Robert", LastName="Reagan", Department=Department.Electronics },
                new Person() { Id= 4 , FirstName="Greta", LastName="Sims", Department=Department.Motors },
                new Person() { Id= 5 , FirstName="Brett", LastName="Wade", Department=Department.Software },
                new Person() { Id= 6 , FirstName="Sandra", LastName="Johnson", Department=Department.Electronics },
                new Person() { Id= 7 , FirstName="Edward", LastName="Holmes", Department=Department.Motors },
                new Person() { Id= 8 , FirstName="Barbara", LastName="Banks", Department=Department.Software },
                new Person() { Id= 9 , FirstName="Kevin", LastName="Carter", Department=Department.Electronics },
                new Person() { Id= 10, FirstName="Cynthia", LastName="Stanwick", Department=Department.Motors },
                new Person() { Id= 11, FirstName="Sam", LastName="Hill", Department=Department.Electronics }};
            return dataSource;
        });
        public static List<Person> DataSource { get { return dataSource.Value; } }
    }

    public class Person {
        public int Id { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public Department Department { get; set; }
        public string Text => $"{FirstName} {LastName} ({Department} Dept.)";
        public override bool Equals(object obj) {
            if (obj is Person typedObj) {
                return (this.Id == typedObj.Id) && (this.FirstName == typedObj.FirstName) && (this.LastName == typedObj.LastName)
                && (this.Department == typedObj.Department);
            }
            return base.Equals(obj);
        }
    }

    public enum Department { Motors, Electronics, Software }
}

When a user types text into the edit box, the ComboBox filters and highlights search results.

ComboBox - Filter Data