TreeListNode.Tag Property

Gets or sets the data associated with a Tree List node.

Namespace: DevExpress.XtraTreeList.Nodes

Assembly: DevExpress.XtraTreeList.v19.2.dll

Declaration

C#

[DefaultValue(null)]
[DXCategory("Data")]
public virtual object Tag { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Data")>
Public Overridable Property Tag As Object

Property Value

Type	Default	Description
Object	*null*	An object containing information associated with the Tree List node.

Remarks

This property can be used to store any object that you want to associate with a node.

Example

The following example demonstrates a way to traverse through root nodes. A Boolean value is assigned to the TreeListNode.Tag property of each visited node. Odd nodes get a true property value, while even nodes get a false value.

C#

bool oddRow = false;
for(int i = 0; i < treeList1.Nodes.Count; i++) {
   treeList1.Nodes[i].Tag = oddRow;
   oddRow = ! oddRow;
}

VB.NET

Dim oddRow As Boolean = False
Dim I As Integer
For I = 0 To TreeList1.Nodes.Count - 1
   TreeList1.Nodes(I).Tag = oddRow
   oddRow = Not oddRow
Next

Related GitHub Examples

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

node-checking-using-state-images-e902/CS/NodeChecking.cs#L39

private void SetCheckedNode(DevExpress.XtraTreeList.Nodes.TreeListNode node) {
    CheckState check = GetCheckState(node.Tag);
    if(check == CheckState.Indeterminate || check == CheckState.Unchecked) check = CheckState.Checked;

Reporting_how-to-implement-a-separate-document-map-using-the-xtratreelist-control-e4516/CS/WindowsFormsApplication1/Form1.cs#L47

    DisplayCurrentBrick(treeList1.FocusedNode.Tag as BookmarkNode);
}

how-to-use-treelist-for-file-management-drag-and-drop-files-and-folders-e3400/CS/FileList/FileListHelper.cs#L103

    if (node.HasChildren)
        node.Tag = true;
}

how-to-implement-node-dynamic-loading-in-unbound-mode-t500394/CS/TreeList-UnboundMode-ViaBeforeExpandEvent/Form1.cs#L100

    if (node.HasChildren)
        node.Tag = true;
}

how-to-use-datatable-with-master-detail-relationships-in-treelist-e3597/CS/E3597/UnboundMasterDetailTree.cs#L52

{
    (e.Node.Tag as DataRow)[e.Column.FieldName] = e.Value;
}

VB.NET

node-checking-using-state-images-e902/VB/NodeChecking.vb#L43

Private Sub SetCheckedNode(ByVal node As DevExpress.XtraTreeList.Nodes.TreeListNode)
    Dim check As CheckState = GetCheckState(node.Tag)
    If check = CheckState.Indeterminate OrElse check = CheckState.Unchecked Then

how-to-use-treelist-for-file-management-drag-and-drop-files-and-folders-e3400/VB/FileList/FileListHelper.vb#L90

If node.HasChildren Then
    node.Tag = True
End If

how-to-implement-node-dynamic-loading-in-unbound-mode-t500394/VB/TreeList-UnboundMode-ViaBeforeExpandEvent/Form1.vb#L86

    node.HasChildren = HasFiles(s)
    If node.HasChildren Then node.Tag = True
Catch

how-to-use-datatable-with-master-detail-relationships-in-treelist-e3597/VB/E3597/UnboundMasterDetailTree.vb#L51

Private Sub _masterTreeList_CellValueChanged(ByVal sender As Object, ByVal e As CellValueChangedEventArgs)
    TryCast(e.Node.Tag, DataRow)(e.Column.FieldName) = e.Value
End Sub

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/VB/WindowsFormsApplication1/Form1.vb#L40

    parents(level) = newNode
    newNode.Tag = item.Range
Next item