IndexSection

A section within an index.

Properties

Property Type Access Description
allTopics Array of Topic readonly The topics in the specified index section.
id number readonly The unique ID of the IndexSection.
index number readonly The index of the IndexSection within its containing object.
label string r/w A property that can be set to any string.
name string readonly The name of the IndexSection.
parent Index readonly The parent of the IndexSection (a Index).
properties Object r/w A property that allows setting of several properties at the same time.
topics Topics readonly A collection of index topics.

Methods

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter Type Description
key string The key.

Array of IndexSection getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter Type Description
key string The key.
value string The value.

string toSource ()
Generates a string which, if executed, will return the IndexSection.

string toSpecifier ()
Retrieves the object specifier.

Used in:

IndexSections.previousItem ( obj: IndexSection)
IndexSections.nextItem ( obj: IndexSection)

Returned by:

Array of IndexSection IndexSection.getElements ( )
IndexSection IndexSections.anyItem ( )
Array of IndexSection IndexSections.everyItem ( )
IndexSection IndexSections.firstItem ( )
IndexSection IndexSections.item ( index: any )
IndexSection IndexSections.itemByID ( id: number )
IndexSection IndexSections.itemByName ( name: string )
Array of IndexSection IndexSections.itemByRange ( from: any, to: any )
IndexSection IndexSections.lastItem ( )
IndexSection IndexSections.middleItem ( )
IndexSection IndexSections.nextItem ( obj: IndexSection )
IndexSection IndexSections.previousItem ( obj: IndexSection )