Tree.getNodeList (Method)
Returns all the nodes of the specified tree.
Returns:
Tree_GetNodeList_Results (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Description | PlainText_2000 | The description of the tree node. |
ImageHeight | NonNegativeInteger | The height of the image, or 0 if no image. |
ImageID | ImageID_0 | The unique ID of an image or 0 for no image. |
ImageServerURL | ServerRelativeURL_EmptyString | The server URL of the image, or empty string if no image. |
ImageURL | ServerRelativeURL_EmptyString | The URL of the image, or empty string if no image. |
ImageWidth | NonNegativeInteger | The width of the image, or 0 if no image. |
ItemClass | CSSNameList_100_EmptyString | The item class of the tree node. |
Level | PositiveInteger | The level of tree node in tree hierarchy. |
NodeID | TreeNodeID | The unique ID of the tree node. |
ParentNodeID | TreeNodeID_0 | The unique ID of the parent node, or 0 if a root node. |
Position | PositiveInteger | The position of the tree node. |
State | ActiveInactive | The state of the tree node. |
TargetID | PageID_0 | The unique ID of the target page, or 0 if no target. |
TargetMouseOver | PlainText_255 | The mouse over action. |
TargetURL | PlainText | The URL of the target page, or empty string if no target. |
Title | PlainText_NonNull_255 | The title of the tree node. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
id | TreeID | Required | The unique ID of a tree. |
includeInactive | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot includes inactive nodes of the tree. |
Context:
License Requirements | (none) |
Permission Requirements | (none) |
Deny Context | (none) |
Require Context | (none) |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None