listObj._getRoute Method

Syntax

listObj._getRoute([useRowNumber [, routeArray]])

Arguments

useRowNumberstring

Specify the route should use row numbers instead of keys. Can be the following value:

Value: Description
rowNumber: Use row numbers

routeArrayobject array

If specified, the selected row data will be appended to this array. For internal use only.

Returns

resultJSON array: Returns an array of objects defining the currently selected rows for the List and all parent and child List controls.

Description

Returns an array of objects defining the currently selected rows for the List and all parent and child List controls.

Discussion

For use with Lists that contain hierarchical data. Gets an array of objects with the current row primary key value (default) or row number in all Lists in the hierarchy. Each object in the array has two properties: list an row. 'list' is the name of the List, and row is the current (zero based) row number that is selected.

For example, say you have three Lists - CUSTOMERS, ORDERS, ORDERDETAILS.

var listObj = {dialog.object}.getControl('CUSTOMERS');

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

This will return an array that might look like this:

[
    {list: 'CUSTOMERS', row: 'ALFKI'},
    {list: 'ORDERS', row: '11063',
    {list: 'ORDERDETAILS', row: '11063|||27'}
]

To use row numbers:

var route = listObj._getRoute('rowNumber');

Limitations

List Control with Detail View Part