IComboBoxSettings.SearchFilterCondition Property

Specifies the search and filter condition.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

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

Property Value

Type	Default	Description
ListSearchFilterCondition	Default	An 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

Use the SearchFilterCondition property to change the combo box search and filter condition at runtime.

The IComboBoxSettings interface allows you to get and customize settings of a combo box editor at runtime. You can get editor settings in the following ways:

• Call the GetColumnEditSettings method to get editor settings of the column bound to the specified data source field.

  Important

  You need to enclose your code between BeginUpdate and EndUpdate method calls to change values of Grid component parameters outside the Grid component markup. Otherwise, an exception occurs.

  var comboBoxSettings = e.Grid.GetColumnEditSettings<IComboBoxSettings>("CategoryId");
  if(comboBoxSettings != null) {
      e.Grid.BeginUpdate();
      comboBoxSettings.SearchFilterCondition=ListSearchFilterCondition.StartsWith;
      e.Grid.EndUpdate();
  }
  

• Handle the CustomizeFilterRowEditor event to customize a cell editor in the filter row.

  void Grid_CustomizeFilterRowEditor(GridCustomizeFilterRowEditorEventArgs e) {
      if(e.EditSettings is IComboBoxSettings comboBoxSettings)
          comboBoxSettings.SearchFilterCondition=ListSearchFilterCondition.StartsWith;
  }
  

• Handle the CustomizeDataRowEditor event to customize a cell editor in a data row.

  void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) {
      if(e.EditSettings is IComboBoxSettings comboBoxSettings)
          comboBoxSettings.SearchFilterCondition=ListSearchFilterCondition.StartsWith;
  }