RepositoryItemGridLookUpEdit.AutoSuggest Event
Fires when you set the SearchMode property to AutoSuggest. In this mode, the editor runs the asynchronous Task assigned in the event handler to retrieve a list of drop-down panel items. See the GridLookUpEdit class description for more information.
Namespace: DevExpress.XtraEditors.Repository
Assembly: DevExpress.XtraGrid.v24.1.dll
NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation
Declaration
Event Data
The AutoSuggest event's data class is LookUpEditAutoSuggestEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Cancel | Cancels the Task assigned to the QuerySuggestions parameter. Inherited from LookUpEditSearchHighlightEventArgs. |
| CancellationToken | An object that cancels the Task assigned to the GetSuggestions method. This object is generated when you call the Cancel method. |
| ClearSuggestions | Clears the editor drop-down menu, removing all items returned by the GetSuggestions task. |
| EditorText | Inherited from LookUpEditSearchHighlightEventArgs. |
| QuerySuggestions | Gets or sets a System.Threading.Tasks.Task object that returns the collection of items, which match the current user text. These items are displayed in the editor drop-down menu. |
| Text | Returns the current user text. Inherited from LookUpEditSearchHighlightEventArgs. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| ClearHighlight() | Removes any active highlight pattern from lookup items. Inherited from LookUpEditSearchHighlightEventArgs. |
| GetHighlighter() | This member supports internal infrastucture and is not intended to be used in code. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightAny(CompareOptions) | Highlights any part of a record that matches the text entered by a user. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightAny(String, CompareOptions) | Highlights any part of a record that matches the given text. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightAny(String, String, CompareOptions) | Highlights any part of a record that belongs to the specific data field and matches the given text. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightAny(String[], String, CompareOptions) | Highlights any part of a record that belongs to certain data fields and matches the given text. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFirst(CompareOptions) | In every data field value, selects the first found text portion that matches the user text. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFirst(String, CompareOptions) | In every data field value, selects the first found text sequence if it matches the user text. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFirst(String, String, CompareOptions) | Selects the first found text sequence if it matches the user text and belongs to the specific data field. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFirst(String[], String, CompareOptions) | Selects the first found text portion that matches the user text and belongs to any of the given data fields. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFromStart(CompareOptions) | If a record starts with the user text, this text portion is highlighted. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFromStart(String, CompareOptions) | If a record starts with the given text, this text portion is higlighted. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFromStart(String, String, CompareOptions) | If a record belongs to the given data field and starts with the specific text, this text portion is highlighted. Inherited from LookUpEditSearchHighlightEventArgs. |
| HighlightFromStart(String[], String, CompareOptions) | If record belongs to any of the given data fields and starts with the specific text, this text portion is higlighted. Inherited from LookUpEditSearchHighlightEventArgs. |
| SetHighlightRange(Func<String, Nullable<DisplayTextHighlightRange>>) | Sets a specific highlight range. Inherited from LookUpEditSearchHighlightEventArgs. |
| SetHighlightRange(Func<String, String, Nullable<DisplayTextHighlightRange>>) | Sets a specific highlight range. Inherited from LookUpEditSearchHighlightEventArgs. |
| SetHighlightRanges(Func<String, String, DisplayTextHighlightRange[]>) | Sets specific highlight ranges. Inherited from LookUpEditSearchHighlightEventArgs. |
| SetMinimumAnimationDuration(Int32) | Sets the minimum duration for the loading indicator that plays while the GetSuggestion task is ongoing. This allows you to prevent this animation from flickering when the task completes too quickly. |
| SetMinimumAnimationDuration(TimeSpan) | Sets the minimum duration for the loading indicator that plays while the GetSuggestion task is ongoing. This allows you to prevent this animation from flickering when the task completes too quickly. |
| SetQuerySuggestionsTask<T>(Task<List<T>>) | Sets a Task that defines the items the LookUpEdit or GridLookUpEdit display in AutoSuggest mode. |
Remarks
The AutoSuggest event fires if the RepositoryItemLookUpEditBase.TextEditStyle property is set to Standard.
See Also