TTreeNode.GetFirstVisibleChild function

Declaration

function GetFirstVisibleChild(aEnabledOnly: Boolean=False): TTreeNode

Arguments

Function result

First matching visible child node for the current node, or Nil when there are no child nodes.

Description

GetFirstVisibleChild is a TTreeNode function used to get the tree node that is the first visible child node in the subtree. The AEnabledOnly argument indicates whether the selected node must also be Enabled. If AEnabledOnly is False, the Enabled property is not examined.

GetFirstVisibleChild calls GetFirstChild to retrieve the first child node in Items. If the first child node is not visible, each of the TTreeNode instances in Items is examined after calling GetNextVisibleSibling.

The return value is the first TTreeNode instance with its Visible property set to True. The return value is Nil if no visible child node was found in Items.

Use GetLastVisibleChild to retrieve the last visible child node in Items.

Modified in LCL version 3.0. Refactored to include the AEnabledOnly argument.

See also

• Items
• Visible
• Enabled
• GetFirstChild
• GetNextVisibleSibling
• GetLastVisibleChild
• TNodeState
• TNodeStates