Skip to main content
A newer version of this page is available. .

LookUpEditAutoSuggestEventArgs Members

Provides data for the LookUpEdit.AutoSuggest and GridLookUpEdit.AutoSuggest events.

Fields

Name Description
Empty static Provides a value to use with events that do not have event data. Inherited from EventArgs.

Properties

Name 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.
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.

Methods

Name Description
ClearHighlight() Removes any active highlight pattern from lookup items. Inherited from LookUpEditSearchHighlightEventArgs.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetHighlighter() This member supports internal infrastucture and is not intended to be used in code. Inherited from LookUpEditSearchHighlightEventArgs.
GetType() Gets the Type of the current instance. Inherited from Object.
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.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
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.
ToString() Returns a string that represents the current object. Inherited from Object.
See Also