Back to Devexpress

AutoCompleteBoxPropertiesBase.FilterMinLength Property

aspnet-devexpress-dot-web-dot-autocompleteboxpropertiesbase-bf1f6f50.md

latest4.6 KB
Original Source

AutoCompleteBoxPropertiesBase.FilterMinLength Property

Gets or sets a value that defines the minimum length for the filter string input, after which filtering operations are initiated.

Namespace : DevExpress.Web

Assembly : DevExpress.Web.v25.2.dll

NuGet Package : DevExpress.Web

Declaration

csharp
[DefaultValue(0)]
public int FilterMinLength { get; set; }
vb
<DefaultValue(0)>
Public Property FilterMinLength As Integer

Property Value

TypeDefaultDescription
Int320

An integer value specifying the minimum length for the filter string input.

|

Remarks

When the editor is in incremental filtering mode, it has the capability to start filtering only after an end-user has typed a specific number of symbols in the editor’s text box. The FilterMinLength property can be used to define the minimum length for the filter string input, after which filtering operations are initiated.

This behavior is extremely useful when the editor works with a large amount of data. Applying a filter each time a new symbol is typed is not sensible, due to the large size of the data set. This could affect web site performance. Instead, delaying the start of filter operations by using the FilterMinLength property allows you to provide end-users with more predictable results, and to improve the performance of your page.

Note

  • The combo box does not display items until the filter string reaches the minimum length (if the FilterMinLength property value is greater than 0 ).
  • The FilterMinLength property synchronizes its value with the editor’s ASPxAutoCompleteBoxBase.FilterMinLength property.

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterMinLength 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.

asp-net-mvc-grid-cascading-combo-boxes-in-batch-edit-mode/CS/Models/ComboBoxPropertiesProvider.cs#L76

csharp
cs.IncrementalFilteringMode = IncrementalFilteringMode.Contains;
cs.FilterMinLength = 2;
cs.CallbackPageSize = 20;

asp-net-mvc-grid-cascading-combo-boxes-in-edit-form/CS/Models/ComboBoxPropertiesProvider.cs#L76

csharp
cs.IncrementalFilteringMode = IncrementalFilteringMode.Contains;
cs.FilterMinLength = 2;
cs.CallbackPageSize = 20;

asp-net-mvc-grid-cascading-combo-boxes-in-batch-edit-mode/VB/Models/ComboBoxPropertiesProvider.vb#L69

vb
cs.IncrementalFilteringMode = IncrementalFilteringMode.Contains
cs.FilterMinLength = 2
cs.CallbackPageSize = 20

asp-net-mvc-grid-cascading-combo-boxes-in-edit-form/VB/Models/ComboBoxPropertiesProvider.vb#L69

vb
cs.IncrementalFilteringMode = IncrementalFilteringMode.Contains
cs.FilterMinLength = 2
cs.CallbackPageSize = 20

See Also

IncrementalFilteringDelay

AutoCompleteBoxPropertiesBase Class

AutoCompleteBoxPropertiesBase Members

DevExpress.Web Namespace