4D v13.4

LISTBOX GET HIERARCHY

Home

 
4D v13.4
LISTBOX GET HIERARCHY

LISTBOX GET HIERARCHY 


 

LISTBOX GET HIERARCHY ( {* ;} object ; hierarchical {; hierarchy} )  
Parameter Type   Description
Operator in If specified, object is an object name (string) If omitted, object is a variable
object  Form object in Object name (if * is specified) or Variable (if * is omitted)
hierarchical  Boolean in True = hierarchical list box False = non-hierarchical list box
hierarchy  Pointer array in Array of pointers

The LISTBOX GET HIERARCHY command lets you find out the hierarchical properties of the list box object designated by the object and * parameters.

If you pass the optional * parameter, you indicate that the object parameter is an object name (string). If you do not pass this parameter, you indicate that the object parameter is a variable. In this case, you pass a variable reference instead of a string. 

The Boolean hierarchical parameter indicates whether or not the list box is in hierarchical mode:

  • if the parameter returns True, the list box is in hierarchical mode,
  • if the parameter returns False, the list box is displayed in non-hierarchical mode (standard array mode).

If the list box is in hierarchical mode, the command fills the hierarchy array with pointers to the arrays of the list box used to set the hierarchy.

Note: If the list box is in non-hierarchical mode, the command returns, in the first element of the hierarchy array, a pointer to the array of the first column of the list box.

 
PROPERTIES 

Product: 4D
Theme: List Box
Number: 1099

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D v12

 
SEE ALSO 

LISTBOX SET HIERARCHY
Managing Hierarchical List Boxes