Class

Topic

 An index topic.

QuickLinks

capitalize, remove

Hierarchy

Index

Topic

CrossReference | PageReference | Subtopic

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	readonly	The name of the Topic.
pageReferences	PageReferences	readonly	A collection of index page references.
parent	Index	readonly	The parent of the Topic (a Index).
properties	Object	r/w	A property that allows setting of several properties at the same time.
subtopics	Subtopics	readonly	A collection of index subtopics.

Methods

Instances

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)

void remove ()
Deletes the Topic.

Element of

CrossReference.parent

CrossReference.referencedTopic

PageReference.parent

Subtopic.parent

Used in:

CrossReference CrossReferences.add (referencedTopic: Topic, crossReferenceType: CrossReferenceType[, customTypeString: string][, withProperties: Object])

Return

Topic Topics.add (name: string[, sortBy: string][, withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index