TreeListColumn.FieldName Property

Gets or sets the field name assigned to the current column from a datasource.

Namespace: DevExpress.XtraTreeList.Columns

Assembly: DevExpress.XtraTreeList.v23.2.dll

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the name of a data field.

Remarks

Use this property to change the field name assigned to the current column from the datasource. If this property is changed at runtime, the column caption is not modified, but the column contents change. In order to update the column caption, set the TreeListColumn.Caption property to the appropriate value.

The FieldName property value can be used as a column identifier, as for example, in the TreeListNode.Item property, TreeListNode.GetValue and other methods.

There must be a case match between strings assigned to the FieldName properties, and the names of the columns in the underlying data source.

Example

The following example demonstrates how to add and adjust a new column bound to the “Checked” field. The column is bound to the field using the TreeListColumn.FieldName property. The sample code changes the caption of the column and its visible index via the TreeListColumn.Caption and TreeListColumn.VisibleIndex properties.

C#

TreeListColumn column = treeList1.Columns.Add();
column.FieldName = "Checked";   
column.Caption = "Check-It";
column.VisibleIndex = treeList1.Columns.Count - 1;

VB.NET

TreeListColumn Column = TreeList1.Columns.Add()
Column.FieldName = "Checked"
Column.Caption = "Check-It"
Column.VisibleIndex = TreeList1.Columns.Count - 1

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#

winforms-treelist-create-file-manager-drag-drop-files-folders/CS/FileList/FileListHelper.cs#L47

this.treeListColumn1.Caption = "FullName";
this.treeListColumn1.FieldName = "FullName";

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L55

    var row = tree.GetDataRecordByNode(e.Node) as DashboardFlatDataSourceRow;
    e.DisplayText = flatData.GetDisplayText(e.Column.FieldName, row);
}

winforms-treelist-expression-editor-xpview/CS/E1887/Form1.cs#L54

    if (column == null) return string.Empty;
    return string.IsNullOrEmpty(column.Caption) ? column.FieldName : column.Caption;
}

XPO_how-to-implement-the-ivirtualtreelistdata-interface-in-xpo-e1601/CS/Q212620/Northwind.cs#L75

public void VirtualTreeGetCellValue(VirtualTreeGetCellValueInfo info) {
    string fieldName = GetTreeListDataFieldName(info.Column.FieldName);
    info.CellData = ClassInfo.GetMember(fieldName).GetValue(this);

winforms-treelist-unbound-columns/CS/TreeList_UnboundDataViaEvent/Form1.cs#L30

unbColumnMarchChange.OptionsColumn.AllowEdit = false;
unbColumnMarchChange.FieldName = "ChangeFromPrevYear";
unbColumnMarchChange.Caption = "Change from Previous Year";

VB.NET

winforms-treelist-create-file-manager-drag-drop-files-folders/VB/FileList/FileListHelper.vb#L46

treeListColumn1.Caption = "FullName"
treeListColumn1.FieldName = "FullName"
treeListColumn2.Caption = "Name"

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L61

    Dim row = TryCast(tree.GetDataRecordByNode(e.Node), DashboardFlatDataSourceRow)
    e.DisplayText = flatData.GetDisplayText(e.Column.FieldName, row)
End Sub

winforms-treelist-expression-editor-xpview/VB/E1887/Form1.vb#L56

    If column Is Nothing Then Return String.Empty
    Return If(String.IsNullOrEmpty(column.Caption), column.FieldName, column.Caption)
End Get

XPO_how-to-implement-the-ivirtualtreelistdata-interface-in-xpo-e1601/VB/Q212620/Northwind.vb#L128

Implements TreeList.IVirtualTreeListData.VirtualTreeGetCellValue
Dim fieldName As String = GetTreeListDataFieldName(info.Column.FieldName)
info.CellData = ClassInfo.GetMember(fieldName).GetValue(Me)

winforms-treelist-unbound-columns/VB/TreeList_UnboundDataViaEvent/Form1.vb#L25

unbColumnMarchChange.OptionsColumn.AllowEdit = False
unbColumnMarchChange.FieldName = "ChangeFromPrevYear"
unbColumnMarchChange.Caption = "Change from Previous Year"