GridColumnCollection.AddField(String) Method

Creates a new hidden column which is bound to the specified field, and appends it to the collection.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public virtual GridColumn AddField(
    string fieldName
)

VB.NET

Public Overridable Function AddField(
    fieldName As String
) As GridColumn

Parameters

Name	Type	Description
fieldName	String	A String value that specifies the name of the data field to which to bind the created column.

Returns

Type	Description
GridColumn	A GridColumn object which represents the new column.

Remarks

Use the GridColumn.VisibleIndex property to control the column’s visibility.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddField(String) method.

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#

reporting-winforms-label-report-in-code/CS/Reporting_how-to-create-a-label-report-at-runtime-t473792/Form1.cs#L61

lookUpLabelProduct.Properties.View.OptionsView.ShowIndicator = false;
GridColumn col1 = lookUpLabelProduct.Properties.View.Columns.AddField("Name");
col1.VisibleIndex = 0;

winforms-grid-use-coloredit-to-edit-unbound-column-string-values/CS/ColorEditExample/Form1.cs#L31

GridColumn unboundColumn = gridView1.Columns.AddField("Color");
unboundColumn.VisibleIndex = gridView1.Columns.Count;

winforms-grid-bind-lookup-column-to-entity-framework/CS/EntitiesLookupWithEditing/Form1.cs#L22

gridView1.Columns.AddField("ProductName").Visible = true;
GridColumn column = gridView1.Columns.AddField("Categories");
RepositoryItemLookUpEdit editor = (RepositoryItemLookUpEdit)gridControl1.RepositoryItems.Add("LookUpEdit");

winforms-grid-display-summary-calculated-over-detail-rows-in-master-row/CS/WindowsApplication59/Form1.cs#L23

gridControl1.ForceInitialize();
GridColumn col = gridView1.Columns.AddField("Tasks");
col.UnboundType = DevExpress.Data.UnboundColumnType.Integer;

winforms-grid-use-layoutview-as-master-view/CS/WindowsApplication3/MasterDetailHelper.cs#L85

private GridColumn CreateColumn() {
    GridColumn column = view.Columns.AddField("Detail");
    column.Visible = true;

VB.NET

reporting-winforms-label-report-in-code/VB/Reporting_how-to-create-a-label-report-at-runtime-t473792/Form1.vb#L53

lookUpLabelProduct.Properties.View.OptionsView.ShowIndicator = False
Dim col1 As GridColumn = lookUpLabelProduct.Properties.View.Columns.AddField("Name")
col1.VisibleIndex = 0

winforms-grid-use-coloredit-to-edit-unbound-column-string-values/VB/ColorEditExample/Form1.vb#L24

gridView1.Columns("ColorString").Visible = False
Dim unboundColumn As GridColumn = gridView1.Columns.AddField("Color")
unboundColumn.VisibleIndex = gridView1.Columns.Count

winforms-grid-bind-lookup-column-to-entity-framework/VB/EntitiesLookupWithEditing/Form1.vb#L21

gridView1.Columns.AddField("ProductName").Visible = True
Dim column As GridColumn = gridView1.Columns.AddField("Categories")
Dim editor As RepositoryItemLookUpEdit = CType(gridControl1.RepositoryItems.Add("LookUpEdit"), RepositoryItemLookUpEdit)

winforms-grid-display-summary-calculated-over-detail-rows-in-master-row/VB/WindowsApplication59/Form1.vb#L19

gridControl1.ForceInitialize()
Dim col As GridColumn = gridView1.Columns.AddField("Tasks")
col.UnboundType = DevExpress.Data.UnboundColumnType.Integer

winforms-grid-use-layoutview-as-master-view/VB/WindowsApplication3/MasterDetailHelper.vb#L95

Private Function CreateColumn() As GridColumn
    Dim column As GridColumn = view.Columns.AddField("Detail")
    column.Visible = True