TreeList.GetVisibleIndexByNode(TreeListNode) Method

Returns the index of the specified node among the visible nodes.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.1.dll

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

Declaration

C#

public int GetVisibleIndexByNode(
    TreeListNode node
)

VB.NET

Public Function GetVisibleIndexByNode(
    node As TreeListNode
) As Integer

Parameters

Name	Type	Description
node	TreeListNode	The TreeListNode object representing the node whose visible index is obtained.

Returns

Type	Description
Int32	An integer value specifying the position of the specified node among the visible nodes.

Remarks

A node is implied invisible if it is a child of a collapsed node. The GetVisibleIndexByNode returns a zero or a greater value when the node is out of the Tree List’s viewable area due to the current scrolling position (see the TreeList.TopVisibleNodeIndex property). This method returns -1 in the cases listed below:

• the specified node is null (Nothing in Visual Basic);
• the specified node is a child of a collapsed node.

Example

The sample code below demonstrates how to determine whether a user sees a given node within the Tree List’s scrollable area. The IsNodeVisibleOnScreen method returns false if the node is invisible or only partially visible at the bottom of the Tree List control.

C#

private bool IsNodeVisibleOnScreen(DevExpress.XtraTreeList.Nodes.TreeListNode node) {
   DevExpress.XtraTreeList.TreeList tree = node.TreeList;
   int visibleIndex = tree.GetVisibleIndexByNode(node);
   return visibleIndex >= tree.TopVisibleNodeIndex && visibleIndex < 
     tree.TopVisibleNodeIndex + tree.ViewInfo.VisibleRowCount;
}

VB.NET

Imports DevExpress.XtraTreeList.Nodes

Private Function IsNodeVisibleOnScreen(ByVal node As TreeListNode) As Boolean
   Dim tree As DevExpress.XtraTreeList.TreeList = node.TreeList
   Dim visibleIndex As Integer = tree.GetVisibleIndexByNode(node)
   Return visibleIndex >= tree.TopVisibleNodeIndex AND visibleIndex < _
     tree.TopVisibleNodeIndex + tree.ViewInfo.VisibleRowCount
End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetVisibleIndexByNode(TreeListNode) 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-save-restore-expanded-state-of-nodes/CS/TreeListViewState.cs#L61

    if(topVisibleNode == null) topVisibleNode = TreeList.FocusedNode;
    TreeList.TopVisibleNodeIndex = TreeList.GetVisibleIndexByNode(topVisibleNode);
}

VB.NET

winforms-treelist-save-restore-expanded-state-of-nodes/VB/TreeListViewState.vb#L68

    End If
    TreeList.TopVisibleNodeIndex = TreeList.GetVisibleIndexByNode(topVisibleNode)
End Try