IComboBoxSettings.SearchMode Property

Specifies whether the component can search for text that users type in the edit box.

Namespace: DevExpress.Blazor

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

[DefaultValue(ListSearchMode.Default)]
[Parameter]
ListSearchMode SearchMode { get; set; }

Property Value

Type	Default	Description
ListSearchMode	Default	An enumeration value.

Available values:

Name	Description
Default	AutoSearch is used. The component searches for text that users type in the edit box.
None	The filter is not applied to list items.
AutoSearch	The component searches for text that users type in the edit box.

Remarks

Use the SearchMode property to change how the combo box editor searches for text 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.SearchMode=ListSearchMode.None;
      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.SearchMode=ListSearchMode.None;
  }
  

• 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.SearchMode=ListSearchMode.None;
  }