GridColumn.FieldName Property

To bind a column to a data source field, set this property to the required data field name. To create an 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 FieldName property value to identify the column.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.1.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