The requested page is not available for the requested platform. You are viewing the content for Default platform.

ListEditor.StartIncrementalSearch(String) Method

Starts an incremental search for the specified string.

Namespace: DevExpress.ExpressApp.Editors

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

public virtual void StartIncrementalSearch(
    string searchString
)
Public Overridable Sub StartIncrementalSearch(
    searchString As String
)

Parameters

Name Type Description
searchString String

The text to locate.

Remarks

Generally, you do not need to call this method. It is automatically used by Lookup Property Editors to start the incremental search. Consider the following scenario. A Lookup Property Editor is selected but not activated:

StartIncrementalSearch1

Then an end-user presses the B key. The lookup dropdown is opened and the B character is passed to the Property Editor's StartIncrementalSearch method. If the number of the objects in the data source collection bound to the current Property Editor is bigger than the IModelOptions.LookupSmallCollectionItemCount property value of the Application Model's IModelOptions node, the B character will be displayed in the search dialog:

StartIncrementalSearch3

Otherwise, the List Editor's control will start the incremental search using the B character as the first one:

StartIncrementalSearch2

The search dialog can be enabled in a Lookup Property Editor regardless of the number of objects contained in the List View's collection source. See, How to: Add a Search Action to Lookup Property Editors and Link Pop-up Windows.

See Also