Topic

Methods:

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

Objects:

Boolean, CrossReferences, EventListeners, Events, Number, Object, PageReferences, String, Topics

Property Listing

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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
name	String	read/write	The name of the Topic.
pageReferences	PageReferences PageReference	readonly	A collection of index page references.
parent	Topic Index IndexSection	readonly	The parent of the Topic (a IndexSection, Topic or Index).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sortOrder	String	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.
topics	Topics Topic	readonly	A collection of index topics.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

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	IndexCapitalizationOptions IndexCapitalizationOptions.ALL_ENTRIES IndexCapitalizationOptions.ALL_LEVEL_1_ENTRIES IndexCapitalizationOptions.INCLUDE_SUBENTRIES IndexCapitalizationOptions.SELECTED_ENTRY	The entry or entries to capitalize. (Optional) (default: IndexCapitalizationOptions.ALL_ENTRIES)

Parameter

Type

Description

capitalizationOption

IndexCapitalizationOptions

IndexCapitalizationOptions.ALL_ENTRIES

IndexCapitalizationOptions.ALL_LEVEL_1_ENTRIES

IndexCapitalizationOptions.INCLUDE_SUBENTRIES

IndexCapitalizationOptions.SELECTED_ENTRY

The entry or entries to capitalize. (Optional)

(default: IndexCapitalizationOptions.ALL_ENTRIES)

Topic getElements ()

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

undefined remove ()

Deletes the Topic.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean