Data Item: Tree

This data item contains a tree of name/value pairs.  These pairs are organized in an ordered tree structure.  Each entry includes a 'name' which is used for display purpose, a 'key' that can be used for classification/comparison and a value.  The entry may optionally include hints on how the entry should be displayed and an optional list of children entries (each of which can also have children). Data values in the tree can be Boolean, Integer, Floats, Date/times, Strings, a Data Item GUID or empty.

Display options

The tree item is displayed as a two column table, where child trees can be nested as an indented collection of entries.  The left column includes controls that enable the children of an entry to be hidden or displayed. To the left of those controls are the 'name' values from the entries. In the right column is the entry value.  The value supports various formatting options for the different types.  The properties that control this are documented in the table at the end of this section.



The tree can be set up to display entries in collapsed or expanded form. In the latter, all of the children are visible. Individual entries support hints that suggest the initial state of entries.  The default visibility state is controlled by these hints (if no hint is given the entry is displayed expanded).  The 'tree_initial_state' can be used to override the hints, but it is applied to the entire tree.  

The 'key' value for each entry is not currently displayed.  Its intended use is focused on filtering or aggregation using generators.

Properties

Property

Value

tree_format_bool

This string is used when the value is a boolean.  It takes the form {XXX}#{YYY} where XXX is the string used for the true value and YYY is the string used for the false value.  The default is: True#False

tree_format_date

When the value is a date/time, this string is used to pick the formatting. See Table Date formatting for specifics. The default is: date_44

tree_format_float

For a float value, this string is used for formatting. See Table Float formatting.  The default is: floatdot2.

tree_format_guid

When the value is a GUID that maps to another valid data item, this value is used to select how the item is displayed.  The value 'link' will display the item via hyperlink to a new page.  The value 'inline' will attempt to display the item directly in the tree view structure.  The default is: link

tree_initial_state

This property allows the tree to be entirely expanded or collapsed initially.   Legal values are: expanded, collapsed and the default is: expanded

tree_bordered

If this property is 0, the tree's border will be removed. The default is 1.

tree_condensed

If this property is 1, the tree's horizontal and vertical height will be minimized making it look compact. The default is 0.

tree_global_toggle

If this property is 1, the option to Expand All/Collapse All nodes of trees will be visible. The default is 0.


 New in 2020 R2:
 The properties tree_bordered, tree_condensed and tree_global_toggle were added.

Created with the Personal Edition of HelpNDoc: Full-featured Help generator