Show TOC

NavigationNode ObjectLocate this document in the navigation structure

Use

The NavigationNode object represents a node in the navigation tree. This object is received as a parameter or returned by most Navigation API methods.

The following table lists properties and methods of the NavigationNode object:

Property/Method

Description

getTitle

Returns the node title (display name)

getNodeURI

Returns the node URI in the following format: ?NavigationTarget=<NodeID>

getName

Returns the node name (ID)

getType

Returns the node type:

  • 0 : iView

  • 1 : page

  • 2 : folder

  • 3 : workset

  • 4 : other

getShowType

Returns the mode in which the node is launched. For details, see Node Launch Mode .

getWinFeatures

Returns the new window attributes, such as width or height

getParent

Returns the parent node of the node

isFirstLevel

Returns true if this is a first level node

getCollections

Returns navigation collections related to the node, such as related services, related links or common tasks

hasChildren

Returns true if the node has child nodes

getChildren

Returns an array of child nodes ( NavigationNode objects)

getAttributeValue

Returns the value of an attribute specified by the key parameter.

getAttribute

Returns the attribute object specified by the key parameter.

setAttributeValue

Sets the value of an attribute. Expects the key and value parameters.

getAttributes

Returns all attributes of the node

getExpireTime

Returns the expiration time of the node