Adobe InDesign CS5 (7.0) Object Model JS: Index

InDesign CS5

Class

Index

An index.

QuickLinks

addEventListener, capitalize, extractLabel, generate, getElements, importTopics, insertLabel, removeEventListener, removeUnusedTopics, toSource, toSpecifier, update

Hierarchy

Document

Index

Event | EventListener | IndexSection | MutationEvent | Topic

Properties

Property	Type	Access	Description
allTopics	Array of Topic	readonly	The topics in the specified index section.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
id	number	readonly	The unique ID of the Index.
index	number	readonly	The index of the Index within its containing object.
indexSections	IndexSections	readonly	A collection of index sections.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the Index; this is an alias to the Index's label property.
parent	Document	readonly	The parent of the Index (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
topics	Topics	readonly	A collection of index topics.

Methods

Instances

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

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)

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of Story generate ([on: varies][, placePoint: Array of Measurement Unit (Number or String)][, destinationLayer: Layer][, autoflowing: bool=false][, includeOverset: bool=false])
Generates a new index story.

Parameter	Type	Description
on	MasterSpread Page Spread	The spread or page on which to place the story. Can accept: Page, Spread or MasterSpread. (Optional)
placePoint	Array of Measurement Unit (Number or String)	The coordinates of the upper left corner of the story bounding box, in the format [x, y]. (Optional)
destinationLayer	Layer	The layer on which to place the story. (Optional)
autoflowing	bool	If true, allows the story to flow onto subsequent pages if the story does not fit on the specified page. If no subsequent pages exist in the document, creates the necessary pages. (Optional) (default: false)
includeOverset	bool	If true, includes topics in overset text in the story. (Optional) (default: false)

Array of Index getElements ()
Resolves the object specifier, creating an array of object references.

void importTopics (from: File)
Imports a list of index topics.

Parameter	Type	Description
from	File	The file from which to import the topics.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

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