Tree (Component)

 

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

addSubsiteBindings [L] Adds subsite bindings for specified tree.
changeNodeState [L] Changes the state of a tree node to 'Active', or 'Inactive'.
changeState [L] Changes the state of a tree to 'Active', or 'Inactive'.
create [L] Creates a new tree.
delete [L] Deletes the specified tree.
deleteNode [L] Deletes a tree node.
getBindableSubsites Returns subsites where user has admin rights that are not bound to a tree in this family.
getChildNodeCount Returns the count of direct children under the specified node.
getInfo Returns a structure describing the information of a tree.
getInfoByName Returns a structure describing the information of a tree.
getList Returns zero or more structures, each containing information of a tree.
getNodeCountByImageReference Returns the count of navigation tree nodes that use the image with the passed imageID.
getNodeCountByLinkReference Returns the count of navigation tree nodes that link to the page with the passed pageID.
getNodeHierarchy Returns an array of tree nodes and all it child nodes hierarchy.
getNodeInfo Returns a structure describing the information of a tree node.
getNodeList Returns all the nodes of the specified tree.
getNodesByImageReference Returns information about navigation tree nodes that use the image with the passed imageID.
getNodesByLinkReference Returns information about navigation tree nodes that link to the page with the passed pageID.
moveNode [L] Moves the specified node to another node or position.
moveNodeDown [L] Moves the specified node to one position up. If the node is at the last position within its parent, it will move below its parent.
moveNodeLeft [L] Moves the specified node (and its children) to be a sibling of its current parent.
moveNodeRight [L] Moves the specified node (and its children) to be a child of the node above it.
moveNodeUp [L] Moves the specified node to one position up. If the node is at the first position within its parent, it will move above its parent.
quickSaveNodes [L] Appends multiple nodes based on the specified node hierarchy string. The string should have one node per line and should use one space characters to delineate different levels.
removeSubsiteBindings [L] Removes subsite bindings for the specified tree.
saveNode [L] Creates a new tree node, or updates and existing one.
update [L] Updates an existing tree.
updateNodeInfo [L] Updates the specified tree node with the specified information.