LookUpColumnInfo Class

A column for a lookup editor.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

[TypeConverter(typeof(LookUpColumnInfoTypeConverter))]
public class LookUpColumnInfo

VB.NET

<TypeConverter(GetType(LookUpColumnInfoTypeConverter))>
Public Class LookUpColumnInfo

Related API Members

The following members accept/return LookUpColumnInfo objects:

• LookUpColumnInfoCollection.CreateColumn()
• LookUpColumnInfoCollection.GetVisibleColumn(Int32)
• LookUpColumnInfoCollection.Item[Int32]
• LookUpColumnInfoCollection.Item[String]

Remarks

The LookUpColumnInfo class represents a single column for a LookUpEdit control. The collection of columns is specified by the RepositoryItemLookUpEdit.Columns property and this represents an instance of the LookUpColumnInfoCollection class. To add a column to the collection, see the LookUpColumnInfoCollection.Add method.

The most important property of the lookup column is LookUpColumnInfo.FieldName. This refers to the field whose values are displayed in the column. You can use the property either to bind the column to a specific field in the RepositoryItemLookUpEditBase.DataSource or define the column as unbound.

A lookup editor allows you to create columns for all fields available in the RepositoryItemLookUpEditBase.DataSource. For this purpose, see the RepositoryItemLookUpEdit.PopulateColumns method.

Example

The following code adds two columns to the RepositoryItemLookUpEdit.Columns collection of a lookup editor. For each column we initialize its field, caption and width.

C#

using DevExpress.XtraEditors.Controls;
//...
lookUpEdit1.Properties.Columns.Add(new LookUpColumnInfo("ID", "No", 20));
lookUpEdit1.Properties.Columns.Add(new LookUpColumnInfo("Name", "Customer Name", 80));

VB.NET

Imports DevExpress.XtraEditors.Controls
' ...
LookUpEdit1.Properties.Columns.Add(New LookUpColumnInfo("ID", "No", 20))
LookUpEdit1.Properties.Columns.Add(New LookUpColumnInfo("Name", "Customer Name", 80))

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LookUpColumnInfo class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

does-the-lookup-editor-support-guid-values-e720/CS/Form1.cs#L118

new DevExpress.XtraEditors.Controls.EditorButton(DevExpress.XtraEditors.Controls.ButtonPredefines.Combo)});
this.lookUpEdit1.Properties.Columns.AddRange(new DevExpress.XtraEditors.Controls.LookUpColumnInfo[] {
new DevExpress.XtraEditors.Controls.LookUpColumnInfo("ID", "ID", 37, DevExpress.Utils.FormatType.None, "", true, DevExpress.Utils.HorzAlignment.Near),

how-to-provide-the-capability-to-show-tooltips-for-lookupedit-items-e3040/CS/LookUpEditWithHints/Form1.cs#L31

LookUpColumnInfoCollection coll = lookUpEditHints1.Properties.Columns;
coll.Add(new LookUpColumnInfo("Customer"));
coll.Add(new LookUpColumnInfo("Description"));

Reporting_parameters-how-to-create-cascading-comboboxes-e4884/CS/WindowsFormsApplication1/XtraReport1.cs#L23

editor1.Properties.Columns.Clear();
editor1.Properties.Columns.Add(new DevExpress.XtraEditors.Controls.LookUpColumnInfo("CategoryName", 200, "CategoryName"));
editor1.EditValueChanged += new EventHandler(XtraReport1_EditValueChanged);

can-i-bind-the-xtraeditors-combobox-to-a-datatable-e747/CS/LookUpEditDemo/Form1.cs#L69

lookUpEdit1.Properties.ValueMember = "ID";
DevExpress.XtraEditors.Controls.LookUpColumnInfo col;
col = new DevExpress.XtraEditors.Controls.LookUpColumnInfo("Name", "Country", 100);

Reporting_how-to-provide-custom-editors-for-the-report-parameters-e390/CS/XtraReport1.cs#L26

lookUpEdit.Properties.ValueMember = "CategoryID";
lookUpEdit.Properties.Columns.Add(new LookUpColumnInfo("CategoryName", 0, "Category Name"));
lookUpEdit.Properties.NullText = "<Select Category>";

VB.NET

how-to-provide-the-capability-to-show-tooltips-for-lookupedit-items-e3040/VB/LookUpEditWithHints/Form1.vb#L29

Dim coll As LookUpColumnInfoCollection = lookUpEditHints1.Properties.Columns
coll.Add(New LookUpColumnInfo("Customer"))
coll.Add(New LookUpColumnInfo("Description"))

Reporting_parameters-how-to-create-cascading-comboboxes-e4884/VB/WindowsFormsApplication1/XtraReport1.vb#L25

editor1.Properties.Columns.Clear()
editor1.Properties.Columns.Add(New DevExpress.XtraEditors.Controls.LookUpColumnInfo("CategoryName", 200, "CategoryName"))
AddHandler editor1.EditValueChanged, AddressOf XtraReport1_EditValueChanged

can-i-bind-the-xtraeditors-combobox-to-a-datatable-e747/VB/LookUpEditDemo/Form1.vb#L70

lookUpEdit1.Properties.ValueMember = "ID"
Dim col As DevExpress.XtraEditors.Controls.LookUpColumnInfo
col = New DevExpress.XtraEditors.Controls.LookUpColumnInfo("Name", "Country", 100)

does-the-lookup-editor-support-guid-values-e720/VB/Form1.vb#L108

Me.lookUpEdit1.Properties.Buttons.AddRange(New DevExpress.XtraEditors.Controls.EditorButton() { New DevExpress.XtraEditors.Controls.EditorButton(DevExpress.XtraEditors.Controls.ButtonPredefines.Combo)})
Me.lookUpEdit1.Properties.Columns.AddRange(New DevExpress.XtraEditors.Controls.LookUpColumnInfo() { New DevExpress.XtraEditors.Controls.LookUpColumnInfo("ID", "ID", 37, DevExpress.Utils.FormatType.None, "", True, DevExpress.Utils.HorzAlignment.Near), New DevExpress.XtraEditors.Controls.LookUpColumnInfo("Item", "Item", 37, DevExpress.Utils.FormatType.None, "", True, DevExpress.Utils.HorzAlignment.Near)})
Me.lookUpEdit1.Properties.DataSource = Me.dataTable2

Reporting_how-to-provide-custom-editors-for-the-report-parameters-e390/VB/XtraReport1.vb#L27

lookUpEdit.Properties.ValueMember = "CategoryID"
lookUpEdit.Properties.Columns.Add(New LookUpColumnInfo("CategoryName", 0, "Category Name"))
lookUpEdit.Properties.NullText = "<Select Category>"

Inheritance

Object

LookUpColumnInfo