Class

Topic

 An index topic.

QuickLinks

addEventListener, capitalize, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Index | IndexSection | Topic
Topic
CrossReference | Event | EventListener | MutationEvent | PageReference | Topic

Properties

PropertyTypeAccessDescription
crossReferencesCrossReferences CrossReference readonlyA collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
indexnumber readonlyThe index of the Topic within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the Topic.
pageReferencesPageReferences PageReference readonlyA collection of index page references.
parentIndex
IndexSection
Topic
readonlyThe parent of the Topic (a IndexSection, Topic or Index).
propertiesObject r/wA property that allows setting of several properties at the same time.
sortOrderstring r/wThe 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.
topicsTopics Topic readonlyA collection of index topics.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
capitalizationOptionIndexCapitalizationOptions:
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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

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.3iContents :: Index