Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiCreateTree

hiCreateTree(
s_treeName
)
=> r_tree / nil

Description

Creates a new tree or sub-tree, to which you then add items you create with the hiCreateTreeItem function. You add the tree to a tree table field created with the hiCreateTreeTable function.

This function should not be built into a context. If it is in a context file, it should be within a function, which runs at a run-time, instead of being inline, which runs when the context is built.

For an overview of the tree table field, see hiCreateTreeTable.

Arguments

s_treeName

The name of the tree, specified as a symbol.

This symbol is the handle to the tree and can be evaluated to return the tree structure.

Values Returned

r_tree

Handle to the tree.

nil

The tree was not created.

Related Topics

Form and Field Functions

hiItemInsertTree

hiCreateTreeItem

hiTreeAppendItem

hiTreePrependItem

hiItemRemoveTree

hiCreateTreeTable


Return to top
 ⠀
X