IComboBoxSettings.FilteringMode Property

Specifies whether and how the combo box editor filters its data.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v23.2.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(DataGridFilteringMode.None)]
[Parameter]
DataGridFilteringMode FilteringMode { get; set; }

Property Value

Type	Default	Description
DataGridFilteringMode	None	An enumeration value.

Available values:

Name	Description
None	The filter is not applied to list items.
StartsWith	Filters the component for list items that begin with the search string.
Contains	Filters the component for list items that contain the search string. Search string matches are highlighted.

Remarks

Use the FilteringMode property to change the combo box editor’s filter mode at runtime. To enable filtering in the combo box editor and specify the editor’s filter mode in markup, use the DxComboBoxSettings.FilteringMode property.

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.FilteringMode= DataGridFilteringMode.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.FilteringMode= DataGridFilteringMode.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.FilteringMode= DataGridFilteringMode.StartsWith;
  }