1. Home
  2. Fields
  3. TreeView Field

TreeView Field

The TreeView Field is a visual component that represents hierarchical data in a tree-like structure, allowing users to expand and collapse sections, and click on an instance to view its content. It is specifically designed to display instances with parent-child relationships between them. The data for the TreeView is returned from a target call.

The TreeView has two types of layout, Basic and Advanced. The Basic layout displays the default TreeView design, and the Advanced layout displays the content using custom HTML and styling.

TreeView Layouts

Where Do We Get the Data for This Control?

Contains the target information of the target that will be called to get the data that will be displayed in the TreeView.

If using a Basic layout, the target should return the following columns: InstanceGUID, InstanceName and ParentGUID.

If using an Advanced layout, the target should return the following columns: InstanceGUID, InstanceName, ParentGUID and Content.

The InstanceName string values are used to create the tree nodes.

The InstanceGUID and ParentGUID of an item must always be different.

The content returned in the content column should be raw HTML/CSS. This is specify how the TreeView items are structured and styled.

The TreeView allows navigation through all nodes, including the root node. To restrict the root node access, remove it from the dataset returned by the target call.

Note: To ensure the TreeView is displayed correctly, the target must return at least one root node. A root node is an item with no parent (in this case, the item’s Parent GUID should be “00000000-0000-0000-0000-000000000000”) or an item whose parent is not present in the data (the parent does not exist as a sperate item in the dataset). The GI_ListInstancesForTreeView stored procedure can be used to test Basic TreeView Layout.

TreeView Type

Determines the type of layout that the TreeView will use.

The TreeView has two types of layout, Basic and Advanced. The Basic layout displays the default TreeView design, and the Advanced layout uses custom HTML and styling for full control of the rendered design.

Note: If using the Advanced layout, an additional content column must be returned by the target.

TreeView Layouts

Allow Instance Navigation

Determines if a tree node can be clicked to navigate to the node’s instance window.

If set to “Yes”, users will be able to click on a tree nodes, and a window will popup displaying the instance’s content.

If set to “No”, users won’t be able to click on tree nodes to view the instances. They will, however, still be able to navigate the tree hierarchy.

Screenshot of a treeview field that opens an instance in a popup window
Updated on August 28, 2024

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for?
Contact Support