ObjectDCL Banner

Tree_GetFirstVisibleItem Method

Description

This method retrieves the unique key of the first visible tree item.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.

Return Values

Returns the following according to the situation:

  • String or Tree Node Handle of the first visible tree item.
  • Nil if the control is not found, is not visible or there is no nodes in the control.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tree_GetFirstVisibleItem 
		MyControlReference [as Reference])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_Tree_GetFirstVisibleItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Get the key of the first visible item
(Setq rValue (Odcl_Tree_GetFirstVisibleItem MyProject_MyForm_MyControl))

See Also

Tree_EnsureVisible Tree_GetNextVisibleItem, Tree_GetPrevVisibleItem, Tree_GetVisibleCount