Topic
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| crossReferences | CrossReferences CrossReference | readonly | A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.) |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| index | number | readonly | The index of the Topic within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | r/w | The name of the Topic. |
| pageReferences | PageReferences PageReference | readonly | A collection of index page references. |
| parent | IndexIndexSection Topic |
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 Topic | readonly | A collection of index topics. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void capitalize ([capitalizationOption:
IndexCapitalizationOptions=IndexCapitalizationOptions.ALL_ENTRIES])
Makes the initial letter for the specified index topic or group of index topics upper case.
| Parameter | Type | Description |
|---|---|---|
| capitalizationOption | IndexCapitalizationOptions: IndexCapitalizationOptions.SELECTED_ENTRY IndexCapitalizationOptions.INCLUDE_SUBENTRIES IndexCapitalizationOptions.ALL_LEVEL_1_ENTRIES IndexCapitalizationOptions.ALL_ENTRIES | The entry or entries to capitalize. (Optional) (default: IndexCapitalizationOptions.ALL_ENTRIES) |
Array of Topic getElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the Topic.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the Topic.
Element of
CrossReference.parent
CrossReference.referencedTopic
Index.allTopics
IndexSection.allTopics
PageReference.parent
Topic.parent
Used in:
CrossReference CrossReferences.add (referencedTopic: Topic, crossReferenceType: CrossReferenceType[, customTypeString: string][, withProperties: Object])
Topic Topics.nextItem (obj: Topic)
Topic Topics.previousItem (obj: Topic)
Return
Array of Topic Topic.getElements ()
Topic Topics.[] (index: number)
Topic Topics.add (name: string[, sortBy: string][, withProperties: Object])
Topic Topics.anyItem ()
Array of Topic Topics.everyItem ()
Topic Topics.firstItem ()
Topic Topics.item (index: varies)
Topic Topics.itemByName (name: string)
Array of Topic Topics.itemByRange (from: varies, to: varies)
Topic Topics.lastItem ()
Topic Topics.middleItem ()
Topic Topics.nextItem (obj: Topic)
Topic Topics.previousItem (obj: Topic)
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |