GridColumn.FieldName Property

To bind a column to a data source field, set this property to the required data field name. To create unbound columns, assign a unique identifier to this property. If you have obtained a column as a method return value or as an event argument, read the FieldName property value to identify the column.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DXCategory("Data")]
[DefaultValue("")]
[XtraSerializableProperty]
public string FieldName { get; set; }

VB.NET

<DXCategory("Data")>
<DefaultValue("")>
<XtraSerializableProperty>
Public Property FieldName As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the unique column field name.

Remarks

The FieldName property does not affect the column GridColumn.Caption.

The Prioritize conditional formatting appearances demo illustrates how to obtain a column by its FieldName and change this column’s appearance.

C#

FormatConditionRuleValue lengthRuleCondition = new FormatConditionRuleValue();
lengthRuleCondition.Condition = FormatCondition.GreaterOrEqual;
lengthRuleCondition.Value1 = 25;
lengthRuleCondition.Appearance.BackColor = Color.MediumSeaGreen;
lengthRuleCondition.Appearance.Options.UseBackColor = true;
GridFormatRule lengthRule = new GridFormatRule() { Column = gridView.Columns["Length"], Rule = lengthRuleCondition };
gridView.FormatRules.Add(lengthRule);

gridView.RowCellStyle += (s, e) => {
    GridView view = s as GridView;
    if (view.IsRowSelected(e.RowHandle) &&
        e.Column.FieldName == "Length" &&
        lengthRule.IsFit(e.CellValue, view.GetDataSourceRowIndex(e.RowHandle)))
    {
        AppearanceObject ruleAppearance = (lengthRule.Rule as FormatConditionRuleAppearanceBase).Appearance;
        e.Appearance.BackColor = ruleAppearance.BackColor;
    }
};

VB.NET

Dim lengthRuleCondition As New FormatConditionRuleValue()
lengthRuleCondition.Condition = FormatCondition.GreaterOrEqual
lengthRuleCondition.Value1 = 25
lengthRuleCondition.Appearance.BackColor = Color.MediumSeaGreen
lengthRuleCondition.Appearance.Options.UseBackColor = True
Dim lengthRule As New GridFormatRule() With {.Column = gridView.Columns("Length"), .Rule = lengthRuleCondition}
gridView.FormatRules.Add(lengthRule)

AddHandler gridView.RowCellStyle, Sub(s, e)
    Dim view As GridView = TryCast(s, GridView)
    If view.IsRowSelected(e.RowHandle) AndAlso e.Column.FieldName = "Length" AndAlso lengthRule.IsFit(e.CellValue, view.GetDataSourceRowIndex(e.RowHandle)) Then
        Dim ruleAppearance As AppearanceObject = (TryCast(lengthRule.Rule, FormatConditionRuleAppearanceBase)).Appearance
        e.Appearance.BackColor = ruleAppearance.BackColor
    End If
End Sub

Note

• For unbound columns, unique FieldName values are required. Otherwise, the ColumnView.CustomUnboundColumnData event is unable to find required columns.
• In the case of data-bound records, it is generally not recommended to have multiple columns bound to the same data field because of multiple limitations this design imposes on Data Grid functionality (inability to access the specific column by the given field name, updates in all related columns when you change a cell value in one of them, unexpected behavior when records are sorted, filtered or groupped, etc.).

Related GitHub Examples

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

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#

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L85

foreach(GridColumn col in grid.SortedColumns) {
    list.Sorting.Add(new SnapListGroupParam(col.FieldName, col.SortOrder));
}

how-to-create-an-appearance-editor-which-is-similar-to-the-one-used-in-the-grid-designer-e2510/CS/WindowsApplication3/Form1.cs#L19

DataTable table = new DataTable();
table.Columns.Add(gridView1.Columns[0].FieldName, typeof(int));
table.Columns.Add(gridView1.Columns[1].FieldName, typeof(string));

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/CS/RangeDate/MyGridControl/MyGridView.cs#L45

{
    CriteriaOperator filter = new BinaryOperator(filterPopup.Column.FieldName, DateTime.Today, BinaryOperatorType.Greater);

XPO_how-to-use-customattribute-to-apply-validation-rules-to-persistent-properties-e2527/CS/Q296004/Form1.cs#L22

Dictionary<string, object> customValues = new Dictionary<string, object>();
customValues.Add(view.FocusedColumn.FieldName, e.Value);
e.ErrorText = new Validator(row, customValues).Validate(view.FocusedColumn.FieldName);

how-to-asynchronously-load-large-data-in-an-unbound-column-e4539/CS/WindowsApplication3/UnboundColumnHelper.cs#L31

void View_CustomUnboundColumnData(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDataEventArgs e) {
    if(e.Column.FieldName == _unboundColumn.FieldName)
        if(e.IsGetData) {

VB.NET

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L88

For Each col As GridColumn In grid.SortedColumns
    list.Sorting.Add(New SnapListGroupParam(col.FieldName, col.SortOrder))
Next col

how-to-create-an-appearance-editor-which-is-similar-to-the-one-used-in-the-grid-designer-e2510/VB/WindowsApplication3/Form1.vb#L21

Dim table As New DataTable()
table.Columns.Add(gridView1.Columns(0).FieldName, GetType(Integer))
table.Columns.Add(gridView1.Columns(1).FieldName, GetType(String))

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/VB/Sample/Form1.vb#L25

customGridControl1.DataSource = myUsers
customGridColumn1.FieldName = "Name"
customGridColumn1.Caption = customGridColumn1.FieldName

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/VB/RangeDate/MyGridControl/MyGridView.vb#L47

Protected Overrides Sub RaiseFilterPopupDate(ByVal filterPopup As DateFilterPopup, ByVal list As List(Of FilterDateElement))
    Dim filter As CriteriaOperator = New BinaryOperator(filterPopup.Column.FieldName, Date.Today, BinaryOperatorType.Greater)

XPO_how-to-use-customattribute-to-apply-validation-rules-to-persistent-properties-e2527/VB/Q296004/Form1.vb#L24

Dim customValues As New Dictionary(Of String, Object)()
customValues.Add(view.FocusedColumn.FieldName, e.Value)
e.ErrorText = New Validator(row, customValues).Validate(view.FocusedColumn.FieldName)