Class AutoCompleteDataColumnInfo

The information needed for setting the attributes of a column in the drop down list of the AutoComplete control.

Inheritance

System.Object

AutoCompleteDataColumnInfo

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public sealed class AutoCompleteDataColumnInfo : Component

Remarks

The AutoComplete control supports displaying multiple columns of data for probable matching items. This class specifies the appearance and behavior of each column that should be visible.

In the case that the DataSource is an external System.Data.DataTable the System.Data.DataColumn objects in the DataTable will be mirrored in the Columns property which is a collection of these objects.

The ColumnHeaderText , MinColumnWidth, ColumnName and Visible properties specify the appearance of the column at runtime.

The MatchingColumn and ImageColumn properties specify how the column is to be treated at runtime. If a Column is set to be the MatchingColumn (the MatchingColumn property is set to true) that column will be used for matching against the current text of the target edit control of the AutoComplete control.

Constructors

AutoCompleteDataColumnInfo()

Initializes an object of type AutoCompleteDataColumnInfo. Overloaded.

Declaration

public AutoCompleteDataColumnInfo()

Remarks

The AutoCompleteDataColumnInfo class holds the information needed to intialize one column in the drop down list view of the AutoComplete control. The initial values for the column name and the default header width are set.

AutoCompleteDataColumnInfo(String, Int32, Boolean)

Initializes an object of type AutoCompleteDataColumnInfo.

Declaration

public AutoCompleteDataColumnInfo(string headerText, int width, bool visible)

Parameters

Type	Name	Description
System.String	headerText	The text for the column header.
System.Int32	width	The width of the column.
System.Boolean	visible	Indicates whether the column is to be visible.

Remarks

This constructor takes the header text, the minimum width and the visible value of the column as parameters to the constructor. You can also use the default constructor and then set the column header using the ColumnHeaderText property and the minimum width by setting MinColumnWidth property.

Fields

columnsCollection

Declaration

public AutoCompleteDataColumnInfoCollection columnsCollection

Field Value

Type
AutoCompleteDataColumnInfoCollection

Properties

ColumnHeaderText

Gets or sets the column header text for the column to be inserted in the AutoComplete class.

Declaration

public string ColumnHeaderText { get; set; }

Property Value

Type
System.String

Remarks

The default value is set to a empty string. The ColumnName property is a read only property and its initial value is set to be the same as the ColumnHeaderText.

ColumnName

Returns the name of the column.

Declaration

public string ColumnName { get; }

Property Value

Type
System.String

Remarks

This is a read only property and the initial value is either set from the column name of a System.Data.DataColumn that this column represents or the ColumnHeaderText that is set initially for this column.

The ColumnHeaderText and ColumnName properties can have different values.

The ColumnName is important in the matching process when the data source is a external System.Data.DataTable as the filtering for the probable match list is performed based on ColumnName.

ImageColumn

Gets or sets whether the column that this item represents is to be treated as the image column.

Declaration

public bool ImageColumn { get; set; }

Property Value

Type
System.Boolean

Remarks

When the value is set to true and this AutoCompleteDataColumnInfo item belongs to a collection all other items are set to non image columns.

MatchingColumn

Gets or sets whether the column that this item represents is to be treated as the matching column.

Declaration

public bool MatchingColumn { get; set; }

Property Value

Type
System.Boolean

Remarks

When the value is set to true and this AutoCompleteDataColumnInfo item belongs to a collection all other items are set to non matching columns.

MinColumnWidth

Gets or sets the minimum column width for the column to be inserted in the ListView of the drop down list in a AutoComplete control.

Declaration

public int MinColumnWidth { get; set; }

Property Value

Type
System.Int32

Remarks

The MinColumnWidth value will be used when inserting columns into the drop down list view of the AutoComplete control.

Visible

Gets or sets whether this column is to be visible.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Remarks

This property affects the visibility of this column at runtime. Any column that is set to be the matching column cannot be set to be invisible.

Methods

SetColumnName(String)

Sets the ColumnName property.

Declaration

public void SetColumnName(string columnName)

Parameters

Type	Name	Description
System.String	columnName	The name of the column.

Remarks

The ColumnName property is kept as a read only property and the initial value of the ColumnName property is set to be the ColumnHeaderText property.

This method is provided in case there is a need for changing the ColumnName after being set from a data source or through the ColumnHeaderText property.

Events

PropertyChanged

PropertyChanged event handler.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler