Show TOC

navigate MethodLocate this document in the navigation structure

Use

navigate(node, mode, params, title, windowAttributes, windowID, workProtect, toHistory, i_postBody)

Triggers navigation to the specified node. The parameters are similar to the parameters received by the EPCM doNavigate() method.

Parameter

Description

node

A NavigationNode object that represents the node to which to navigate

mode

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

params

A string that represents a set of GET parameters to be passed with the request, in the following format: <key>=<value>&<key>=<value>&...<key>=<value>

title

The window title when the content is displayed in a new window

windowAttributes

When the target is displayed in a new window, a string that defines the window's attributes, such as width and height. The string is a comma separated list of attributes with no blanks, with the same syntax as the string provided to the JavaScript window.open() method.

For example, width=400,height=500 .

windowID

When the content is displayed in a new window, the ID of this window. If a window with the specified ID already exists, the navigation is performed in this window instead of opening a new window.

workProtect

If true (default), the user is prompted to save the data before leaving a session

toHistory

An integer that indicates how to add this navigation to the history, as follows:

0 : add to history and allow duplicates

1 : add to history and do not allow duplicates

2 : do not add to history

i_postBody

An array of objects, each of which represents a POST parameter to be passed with the request. For each object in the array, set its name and value properties.

Return Value

None