An index topic.
Go to Property Listing | Method Listing
capitalize, getElements, move, remove, toSource, toSpecifier
CrossReferences, Number, Object, PageReferences, String, Topics
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.) |
||
|
readonly |
The index of the Topic within its containing object. |
||
|
read/write |
The name of the Topic. |
||
|
readonly |
A collection of index page references. |
||
|
readonly |
The parent of the Topic (a IndexSection, Topic or Index). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
read/write |
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. |
||
|
readonly |
A collection of index topics. |
undefined capitalize ([capitalizationOption:IndexCapitalizationOptions=IndexCapitalizationOptions])
Makes the initial letter for the specified index topic or group of index topics upper case.
|
Parameter |
Type |
Description |
|---|---|---|
|
capitalizationOption |
The entry or entries to capitalize. (Optional) (default: IndexCapitalizationOptions.ALL_ENTRIES) |
Object getElements ()
Resolves the object specifier, creating an array of object references.
Topic move (to:Number)
Moves the topic to the specified location.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The location. |
undefined remove ()
Deletes the Topic.
String toSource ()
Generates a string which, if executed, will return the Topic.
String toSpecifier ()
Retrieves the object specifier.
CrossReference.parent
PageReference.parent
Topic.parent
CrossReference.referencedTopic
Index.allTopics
IndexSection.allTopics