Class AutoCompleteItemEventArgs

The event data for AutoCompleteSelected event. This event is raised by the AutoComplete class when the user selects an item in the list off possible matches for the current text being displayed in the target edit control.

Inheritance

System.Object

System.EventArgs

AutoCompleteItemEventArgs

Inherited Members

System.EventArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class AutoCompleteItemEventArgs : EventArgs

Remarks

AutoCompleteItemEventHandler is the event handler delegate that uses this class as the event data.

Constructors

AutoCompleteItemEventArgs(Object[], Int32)

Creates an object of type AutoCompleteSelectedEventArgs and sets the internal object array with the information about the currently selected item.

Declaration

public AutoCompleteItemEventArgs(object[] array, int matchColumnIndex)

Parameters

Type	Name	Description
System.Object[]	array	The array that holds the information about the currently selected item.
System.Int32	matchColumnIndex	The column index to be used for matching.

Remarks

The array value set through this constructor can be accessed through the ItemArray property.

Properties

Handled

Replaces the previously SelectedValue with newly Selected Value. The default value of Handled property is false.

Declaration

public bool Handled { get; set; }

Property Value

Type
System.Boolean

ItemArray

Returns the Auto Complete item as an object array.

Declaration

public object[] ItemArray { get; }

Property Value

Type
System.Object[]

Remarks

This property holds the information about the currently selected item. The first item in the array is the first column of the matching item and so on for all the sub items.

MatchColumnIndex

Returns the index of the item that was used for the matching.

Declaration

public int MatchColumnIndex { get; }

Property Value

Type
System.Int32

Remarks

This index could be different from the matching index of the AutoComplete control. The ItemArray returned will only have items/columns that are displayed in the drop down list of the AutoComplete control.

SelectedValue

Gets/Sets the value selected.

Declaration

public string SelectedValue { get; set; }

Property Value

Type
System.String