listObj._setRoute Method

Syntax

listObj._setRoute(routeArray);

Arguments

routeArrayJSON Object: A JSON Object that defines the currently selected row for all parent and child lists for the List control. See ._getRoute() for an example.

Description

For use with Lists that contain hierarchical data. Sets the selected row on each List in the routeArray.

Discussion

See ._getRoute() method for more details.

Example

var listObj = {dialog.object}.getControl("LIST1");

if (listObj) {
    var route = listObj._getRoute();

    // other actions on the list that may affect the selected row(s)

    listObj._setRoute(route);
}

If you don't pass in a routeArray to the method, the method will look for a value in the list object's '__currentRoute' property. This property is automatically set when you call the {dialog.object}.saveListEdits() method.

Limitations

List Control with Detail View Part