Tree.updateNodeInfo (Method)
Updates the specified tree node with the specified information.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
id | TreeID | Required | The unique ID of the tree. |
nodeID | TreeNodeID | Required | The unique ID of the tree node to update. |
title | PlainText_NonNull_255 | Required | The title of the tree node. |
description | PlainText_2000 | Optional. Defaults to an empty string. | The description of the tree node. |
targetID | PageID_0 | Optional. Defaults to '0'. | The unique ID of the target page, uploaded document or registered URL. 0 if the node does not link to a CommonSpot page, uploaded document ore registered URL, or if the node links to an external URL. |
targetURL | PlainText | Optional. Defaults to an empty string. | The fully qualified URL, if the node links to an external URL, otherwise an empty string. |
targetMouseOver | PlainText_255 | Optional. Defaults to an empty string. | The mouse over action. |
targetWindowParams | LinkTargetWindowProperties_Struct | Optional. Defaults to '#Request.TypeFactory.getStruct('LinkTargetWindowProperties_Struct')#'. | Structure of parameters for the target window. |
itemClass | CSSNameList_100_EmptyString | Optional. Defaults to an empty string. | The item class of the tree node. |
imageID | ImageID_0 | Optional. Defaults to '0'. | The unique ID of an image or 0 for no image. |
state | ActiveInactive | Optional. Defaults to 'Active'. | The state of the tree node, i.e. 'Active' or 'Inactive'. |
properties | Struct | Optional. Defaults to '#StructNew()#'. | A structure that describes all of the properties for the tree node. |
Context:
License Requirements | (none) |
Permission Requirements | treeNav:Edit |
Deny Context | (none) |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
Customization | Customization is not supported for this method. |
Error Codes:
Code | Error Message |
---|---|
403 | |
409 | |
87504 | The specified node is not valid for the specified tree. |
Notes:
None