Topic

An index topic.

Methods:

capitalize, remove

Objects:

CrossReferences, Number, Object, PageReferences, String, Subtopics

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.)

index

Number

readonly

The index of the Topic within its containing object.

name

String

readonly

The name of the Topic.

pageReferences

PageReferences PageReference

readonly

A collection of index page references.

parent

Index

readonly

The parent of the Topic (a Index).

properties

Object

read/write

A property that allows setting of several properties at the same time.

subtopics

Subtopics Subtopic

readonly

A collection of index subtopics.

Method Listing

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)

undefined remove ()

Deletes the Topic.

Object of

CrossReference.parent

PageReference.parent

Subtopic.parent

CrossReference.referencedTopic

Return

Topics.add()