Back to Devexpress

TreeListNode.GetDisplayText(Object) Method

windowsforms-devexpress-dot-xtratreelist-dot-nodes-dot-treelistnode-dot-getdisplaytext-x28-system-dot-object-x29.md

latest6.0 KB
Original Source

TreeListNode.GetDisplayText(Object) Method

Returns the text representation of a specific column value.

Namespace : DevExpress.XtraTreeList.Nodes

Assembly : DevExpress.XtraTreeList.v25.2.dll

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

Declaration

csharp
public virtual string GetDisplayText(
    object columnID
)
vb
Public Overridable Function GetDisplayText(
    columnID As Object
) As String

Parameters

NameTypeDescription
columnIDObject

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

|

Returns

TypeDescription
String

A text string that represents a specific column value.

|

Remarks

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

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.

csharp
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
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

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.

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

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

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

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

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

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

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

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

See Also

TreeListNode Class

TreeListNode Members

DevExpress.XtraTreeList.Nodes Namespace