An index topic.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| crossReferences | CrossReferences | readonly | A collection of cross references. |
| index | number | readonly | The index of the Topic within its containing object. |
| name | string | r/w | The name of the Topic. |
| pageReferences | PageReferences | readonly | A collection of index page references. |
| parent | any | readonly | The parent of the Topic (a IndexSection, Topic or Index). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| sortOrder | string | r/w | The string by which the topic is sorted instead of the topic name is not used. Note: The actual topic text, rather than the sort order text, appears in the index. |
| topics | Topics | readonly | A collection of index topics. |
Methods
void capitalize ([capitalizationOption:
IndexCapitalizationOptions=ALL_ENTRIES ])
Makes the initial letter for the specified index topic or group of index topics upper case.
| Parameter | Type | Description |
|---|---|---|
| capitalizationOption | IndexCapitalizationOptions : SELECTED_ENTRY INCLUDE_SUBENTRIES ALL_LEVEL_1_ENTRIES ALL_ENTRIES |
The entry or entries to capitalize. (Optional) (default: ALL_ENTRIES ) |
Array of TopicgetElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the Topic.
string toSource ()
Generates a string which, if executed, will return the Topic.
string toSpecifier ()
Retrieves the object specifier.
Element of:
CrossReference.parent
CrossReference.referencedTopic
Index.allTopics
IndexSection.allTopics
PageReference.parent
Used in:
CrossReferences.add (
referencedTopic:
Topic , crossReferenceType:
CrossReferenceType[, customTypeString:
string][, withProperties:
Object])
Topics.previousItem (
obj:
Topic )
Topics.nextItem (
obj:
Topic )
Returned by:
Array of Topic Topic .getElements (
)
Topic Topics.add (
name:
string[, sortBy:
string][, withProperties:
Object]
)
Topic Topics.anyItem (
)
Array of Topic Topics.everyItem (
)
Topic Topics.firstItem (
)
Topic Topics.item (
index:
any
)
Topic Topics.itemByName (
name:
string
)
Array of Topic Topics.itemByRange (
from:
any, to:
any
)
Topic Topics.lastItem (
)
Topic Topics.middleItem (
)
Topic Topics.nextItem (
obj:
Topic
)
Topic Topics.previousItem (
obj:
Topic
)