ListCaptions.getCaptionIndex

Syntax

getCaptionIndex(caption): Number;

Parameters

caption. PP.Ui.Caption. Title.

Description

The getCaptionIndex method returns title index.

Example

Executing the example requires the SimpleTreeList component with the Tree identifier (see Example of Creating the SimpleTreeList Component).

// Get tree titles
caps = Tree.getCaptions();
// Get title
cap = caps.getCaptions()[1];
// Get title index
caps.getCaptionIndex(cap);

After executing the example title index is obtained.

See also:

ListCaptions