IndexSection

A section within an index.

Go to Property Listing | Method Listing

Methods:

extractLabel, getElements, insertLabel, toSource, toSpecifier

Objects:

Number, Object, String, Topic, Topics

Property Listing

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	read/write	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	read/write	A property that allows setting of several properties at the same time.
topics	Topics Topic	readonly	A collection of index topics.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

IndexSection getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

Object of

Topic.parent

Return

IndexSection.getElements()

IndexSections.anyItem()

IndexSections.everyItem()

IndexSections.nextItem()

IndexSections.previousItem()

IndexSections.itemByID()

IndexSections.item()

IndexSections.itemByName()

IndexSections.itemByRange()

IndexSections.firstItem()

IndexSections.lastItem()

IndexSections.middleItem()