RowProperties.FieldName Property

Gets or sets the name of the data source field to bind to a row item.

Namespace: DevExpress.XtraVerticalGrid.Rows

Assembly: DevExpress.XtraVerticalGrid.v18.2.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	A String value specifying the name of the data field bound to a row.

Remarks

If your grid control operates in one of its bound modes, it accesses data from the associated data source object. A data source is bound to the grid control with the help of the VGridControl.DataSource and VGridControl.DataMember properties. In this case rows correspond to data source fields. Use the FieldName property to specify the name of the data source field from which a row item should acquire data.

The FieldName property value can also be used as a row item identifier, for instance, in the MultiEditorRowPropertiesCollection.Item property.

If you change this property at runtime to bind a row item to another data field, ensure to update the row item caption as well. For this purpose, set the RowProperties.Caption property to the appropriate value which describes data represented by the bound field.

When working in Unbound Mode the grid control has no data source associated with it. In this case, the FieldName property is not in effect. Each row (row item) in this mode has a single data cell whose initial value can be set via the RowProperties.Value property.

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-display-the-password-characters-instead-of-text-within-the-propertygridcontrol-e1095/CS/Q140616/Form1.cs#L22

PropertyGridControl control = (PropertyGridControl)sender;
MemberInfo[] mi = control.SelectedObject.GetType().GetMember(e.Row.Properties.FieldName);
PasswordPropertyTextAttribute attr = (PasswordPropertyTextAttribute)Attribute.GetCustomAttribute(mi[0], typeof(PasswordPropertyTextAttribute));

how-to-obtain-a-row-object-by-fieldname-in-the-xtraverticalgrid-e755/CS/Form1.cs#L280

else
    if (row.Properties.FieldName == fieldName)
    FocusRow(row);

how-to-create-a-propertygridcontrol-descendant-class-supporting-paintvalue-in-uitypeeditor-t124141/CS/dxPaintValue/MyPropertyGridControl.cs#L17

public DescriptorContext GetDescriptorContext(RowProperties properties) {
    return DataModeHelper.GetDescriptorContext(properties.FieldName);
}

how-to-sort-records-in-the-vgridcontrol-e2014/CS/Q245442/Form1.cs#L38

    hitInfo.Row.Tag = currentSortOrder;
    this.categoriesSortableSource.ApplySort(hitInfo.Row.Properties.FieldName, currentSortOrder);
}

VB.NET

how-to-display-the-password-characters-instead-of-text-within-the-propertygridcontrol-e1095/VB/Q140616/Form1.vb#L24

Dim control As PropertyGridControl = CType(sender, PropertyGridControl)
Dim mi() As MemberInfo = control.SelectedObject.GetType().GetMember(e.Row.Properties.FieldName)
Dim attr As PasswordPropertyTextAttribute = CType(Attribute.GetCustomAttribute(mi(0), GetType(PasswordPropertyTextAttribute)), PasswordPropertyTextAttribute)

how-to-obtain-a-row-object-by-fieldname-in-the-xtraverticalgrid-e755/VB/Form1.vb#L269

Else
    If row.Properties.FieldName = fieldName Then
    FocusRow(row)

how-to-create-a-propertygridcontrol-descendant-class-supporting-paintvalue-in-uitypeeditor-t124141/VB/dxPaintValue/MyPropertyGridControl.vb#L19

Public Function GetDescriptorContext(ByVal properties As RowProperties) As DescriptorContext
    Return DataModeHelper.GetDescriptorContext(properties.FieldName)
End Function

how-to-sort-records-in-the-vgridcontrol-e2014/VB/Q245442/Form1.vb#L46

    hitInfo.Row.Tag = currentSortOrder
    Me.categoriesSortableSource.ApplySort(hitInfo.Row.Properties.FieldName, currentSortOrder)
End Sub