Indesign Scripting Reference
home | search | Links
JavaScript >> Index

Index

An index.

Index Properties

Property Type Access Description
allTopics Array of Topics read A flattened 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.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
topics Topics read All index topics.

Index Methods

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.
getElements Array of Objects Resolve the object specifier.
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.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.
update Nothing Update the page numbers in the index.