TreeListNode.GetDisplayText(Object) Method

Returns the text representation of a specific column value.

Namespace: DevExpress.XtraTreeList.Nodes

Assembly: DevExpress.XtraTreeList.v24.1.dll

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

Declaration

C#

public virtual string GetDisplayText(
    object columnID
)

VB.NET

Public Overridable Function GetDisplayText(
    columnID As Object
) As String

Parameters

Name	Type	Description
columnID	Object	An object that identifies a column (a TreeListColumn object, field name, column’s absolute index or corresponding DataColumn object).

Returns

Type	Description
String	A text string that represents a specific column value.

Remarks

The following objects and values can be passed as column identifiers:

• TreeListColumn object
• TreeListColumn.FieldName value
• TreeListColumn.AbsoluteIndex value
• System.Data.DataColumn object (when TreeList.DataSource represents the System.Data.DataView or System.Data.DataTable source)

Example

The following example iterates through root nodes of the Tree List and changes the “Budget” column value for the “Sales and Marketing” department.TreeListColumn instances are used as column identifiers in the TreeListNode.GetDisplayText, TreeListNode.GetValue and TreeListNode.SetValue methods.

C#

IEnumerator en = treeList1.Nodes.GetEnumerator();
TreeListColumn columnDep = treeList1.Columns["Department"];
TreeListColumn columnBudget = treeList1.Columns["Budget"];
while (en.MoveNext()) {
   TreeListNode childNode = (TreeListNode)en.Current;
   if(childNode.GetDisplayText(columnDep) == "Sales and Marketing") {
      decimal newBudget = (decimal)childNode.GetValue(columnBudget) / 2;
      childNode.SetValue(columnBudget, newBudget);
   }
}

VB.NET

Dim en As IEnumerator = TreeList1.Nodes.GetEnumerator()
Dim ColumnDep As TreeListColumn = TreeList1.Columns("Department")
Dim ColumnBudget As TreeListColumn = TreeList1.Columns("Budget")
While en.MoveNext() = True
   Dim ChildNode As TreeListNode = CType(en.Current, TreeListNode)
   If ChildNode.GetDisplayText(ColumnDep) = "Sales and Marketing" Then
      Dim NewBudget As Decimal = CType(ChildNode.GetValue(ColumnBudget), Decimal) / 2
      ChildNode.SetValue(ColumnBudget, NewBudget)
   End If
End While

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDisplayText(Object) 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#

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

Cursor.Current = Cursors.WaitCursor;
InitFolders(e.Node.GetDisplayText("FullName"), e.Node);
e.Node.Tag = null;

winforms-treelist-dynamic-load-nodes-unbound-mode/CS/TreeList-UnboundMode-ViaBeforeExpandEvent/Form1.cs#L137

Cursor.Current = Cursors.WaitCursor;
InitFolders(e.Node.GetDisplayText("FullName"), e.Node);
e.Node.Tag = null;

VB.NET

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

Cursor.Current = Cursors.WaitCursor
InitFolders(e.Node.GetDisplayText("FullName"), e.Node)
e.Node.Tag = Nothing

winforms-treelist-dynamic-load-nodes-unbound-mode/VB/TreeList-UnboundMode-ViaBeforeExpandEvent/Form1.vb#L124

Cursor.Current = Cursors.WaitCursor
InitFolders(e.Node.GetDisplayText("FullName"), e.Node)
e.Node.Tag = Nothing