Index

An index.

Property	Type	Access	Description
AllTopics	Array of Topics	read	A ﬂattened list of all the child topics.
Id	Long	read	A unique number identifying the object.
Index	Long	read	Index of the object within its parent object.
IndexSections	IndexSections	read	All sections within an index.
Label	String	r/w	A label that can be set to any string.
Name	String	r/w	The name of the object.
Parent	Object	read	The parent of the object.
Topics	Topics	read	All index topics.

Method	Returns	Description
Capitalize	Nothing	Applies capitalization options to the index entries.
ExtractLabel	String	Gets the content of the label associated with the specified key (name).
Generate	Array of Stories	Generate a new index story.
ImportTopics	Nothing	Imports a list of topics.
InsertLabel	Nothing	Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
RemoveUnusedTopics	Nothing	Removes all unused index entries.
Update	Nothing	Update the page numbers in the index.