Application

The application.

Properties

Property	Type	Access	Description
activeBook	Book	r/w	Current active book
activeDocument	Document	r/w	The front-most document.
activeScript	File	readonly	The current script running from the scripts panel.
activeWindow	any	r/w	The front-most window. Can return: Window, LayoutWindow or StoryWindow.
alignDistributePreferences	AlignDistributePreference	readonly	Preferences for alignment and distribution.
allCellStyles	Array of CellStyle	readonly	All Cell styles
allCharacterStyles	Array of CharacterStyle	readonly	Lists all character styles (regardless of their group).
allObjectStyles	Array of ObjectStyle	readonly	All object styles contained by the Application.
allParagraphStyles	Array of ParagraphStyle	readonly	Lists all paragraph styles (regardless of their group).
allTableStyles	Array of TableStyle	readonly	All Table styles
anchoredObjectDefaults	AnchoredObjectDefault	readonly	Anchored object default settings.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
autoCorrectPreferences	AutoCorrectPreference	readonly	Auto-correct preferences.
autoCorrectTables	AutoCorrectTables	readonly	A collection of auto-correct tables.
baselineFrameGridOptions	BaselineFrameGridOption	readonly	Baseline frame grid option settings.
books	Books	readonly	A collection of books.
buttonPreferences	ButtonPreference	readonly	Button preference settings.
cellStyleGroups	CellStyleGroups	readonly	A collection of cell style groups.
cellStyles	CellStyles	readonly	A collection of cell styles.
changeGlyphPreferences	ChangeGlyphPreference	r/w	Change glyph preferences. Can also accept: NothingEnum enumerator.
changeGrepPreferences	ChangeGrepPreference	r/w	Change grep preferences. Can also accept: NothingEnum enumerator.
changeObjectPreferences	ChangeObjectPreference	r/w	Change object preferences. Can also accept: NothingEnum enumerator.
changeTextPreferences	ChangeTextPreference	r/w	Change text preferences. Can also accept: NothingEnum enumerator.
characterStyleGroups	CharacterStyleGroups	readonly	A collection of character style groups.
characterStyles	CharacterStyles	readonly	A collection of character styles.
clearOverridesWhenApplyingStyle	bool	r/w	Clear overrides first before applying object style
clipboardPreferences	ClipboardPreference	readonly	Clipboard preference properties that define the way that the application interacts with the system clipboard.
colors	Colors	readonly	A collection of colors.
colorSettings	ColorSetting	readonly	Color setting properties that define color management defaults.
dashedStrokeStyles	DashedStrokeStyles	readonly	A collection of dashed stroke styles.
dataMergeOptions	DataMergeOption	readonly	The data merge option properties that define the data merge.
dialogs	Dialogs	readonly	A collection of dialogs.
dictionaryPreferences	DictionaryPreference	readonly	User dictionary preference settings.
displayPerformancePreferences	DisplayPerformancePreference	readonly	Display performance settings.
displaySettings	DisplaySettings	readonly	Display setting properties.
documentPreferences	DocumentPreference	readonly	Document preference settings.
documentPresets	DocumentPresets	readonly	A collection of document presets.
documents	Documents	readonly	A collection of documents.
dottedStrokeStyles	DottedStrokeStyles	readonly	A collection of dotted stroke styles.
epsExportPreferences	EPSExportPreference	readonly	EPS export preferences.
epsImportPreferences	EPSImportPreference	readonly	EPS import preference settings.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
excelImportPreferences	ExcelImportPreference	readonly	Excel import preferences.
exportForWebPreferences	ExportForWebPreference	readonly	The default export for web preferences.
featureSet	FeatureSetOptions : ROMAN JAPANESE	readonly	The feature set.
filePath	File	readonly	The full path to the file.
findChangeGlyphOptions	FindChangeGlyphOption	r/w	Find/change glyph options. Can also accept: NothingEnum enumerator.
findChangeGrepOptions	FindChangeGrepOption	r/w	Find/change grep options. Can also accept: NothingEnum enumerator.
findChangeObjectOptions	FindChangeObjectOption	r/w	Find/change object options. Can also accept: NothingEnum enumerator.
findChangeTextOptions	FindChangeTextOption	r/w	Find/change text options. Can also accept: NothingEnum enumerator.
findGlyphPreferences	FindGlyphPreference	r/w	Find glyph preferences. Can also accept: NothingEnum enumerator.
findGrepPreferences	FindGrepPreference	r/w	Find grep preferences. Can also accept: NothingEnum enumerator.
findObjectPreferences	FindObjectPreference	r/w	Find object preferences. Can also accept: NothingEnum enumerator.
findTextPreferences	FindTextPreference	r/w	Find text preferences. Can also accept: NothingEnum enumerator.
flattenerPresets	FlattenerPresets	readonly	A collection of transparency flattener presets.
fonts	Fonts	readonly	A collection of fonts.
footnoteOptions	FootnoteOption	readonly	Footnote option settings.
frameFittingOptions	FrameFittingOption	readonly	The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
fullName	File	readonly	The full path to the Application, including the name of the Application.
galleyPreferences	GalleyPreference	readonly	Galley preference settings.
generalPreferences	GeneralPreference	readonly	General preference settings.
grabberPreferences	GrabberPreference	readonly	Grabber preference properties that define display performance quality during scrolling.
gradients	Gradients	readonly	A collection of gradients.
gridPreferences	GridPreference	readonly	Grid preference settings.
guidePreferences	GuidePreference	readonly	Guide preference settings.
imageIOPreferences	ImageIOPreference	readonly	The image I/O preference properties that define preferences for importing images.
imagePreferences	ImagePreference	readonly	Image preferences.
imePreferences	IMEPreference	readonly	IME preference settings.
importedPageAttributes	ImportedPageAttribute	readonly	Placed InDesign document page attributes.
incopyExportOptions	InCopyExportOption	readonly	Export options for InCopy INCX document format
indexGenerationOptions	IndexOptions	readonly	The index options properties that define how an index is formatted.
indexingSortOptions	IndexingSortOptions	readonly	Every sort option
inks	Inks	readonly	A collection of inks.
jpegExportPreferences	JPEGExportPreference	readonly	JPEG export preferences.
label	string	r/w	A property that can be set to any string.
languagesWithVendors	LanguagesWithVendors	readonly	A collection of languages with vendors.
layoutAdjustmentPreferences	LayoutAdjustmentPreference	readonly	Layout sdjustment preference settings.
layoutWindows	LayoutWindows	readonly	A collection of layout windows.
libraries	Libraries	readonly	A collection of object libraries.
locale	Locale : DANISH_LOCALE ENGLISH_LOCALE INTERNATIONAL_ENGLISH_LOCALE FINNISH_LOCALE FRENCH_LOCALE GERMAN_LOCALE ITALIAN_LOCALE PORTUGUESE_LOCALE SPANISH_LOCALE SWEDISH_LOCALE JAPANESE_LOCALE ARABIC_LOCALE CZECH_LOCALE GREEK_LOCALE HEBREW_LOCALE HUNGARIAN_LOCALE POLISH_LOCALE ROMANIAN_LOCALE RUSSIAN_LOCALE TURKISH_LOCALE UKRAINIAN_LOCALE	readonly	The locale to use for language, time zone, and so on.
marginPreferences	MarginPreference	readonly	Margin preference settings.
menuActions	MenuActions	readonly	A collection of menu actions.
menus	Menus	readonly	A collection of menus.
mixedInkGroups	MixedInkGroups	readonly	A collection of mixed ink groups.
mixedInks	MixedInks	readonly	A collection of mixed inks.
modalState	bool	readonly	If true, a modal dialog or alert is active.
name	string	readonly	The name of the Application.
notePreferences	NotePreference	readonly	Note preference settings.
numberingLists	NumberingLists	readonly	A colleciton of numbered lists.
objectStyleGroups	ObjectStyleGroups	readonly	A collection of object style groups.
objectStyles	ObjectStyles	readonly	A collection of object styles.
pageItemDefaults	PageItemDefault	readonly	The default page item formatting for the Application.
panels	Panels	readonly	A collection of panels. Note: Not available for InDesign server.
paragraphStyleGroups	ParagraphStyleGroups	readonly	A collection of paragraph style groups.
paragraphStyles	ParagraphStyles	readonly	A collection of paragraph styles.
parent	Application	readonly	The parent of the Application (a Application).
pasteboardPreferences	PasteboardPreference	readonly	Pasteboard preference settings.
pdfExportPreferences	PDFExportPreference	readonly	A collection of PDF export preferences.
pdfExportPresets	PDFExportPresets	readonly	A collection of PDF export presets.
pdfPlacePreferences	PDFPlacePreference	readonly	The PDF place preference properties that define how PDF files are placed in the current document.
placeableFileExtensions	Array of string	readonly	Lists the extensions of file types that can be placed.
placeableFileTypes	Array of string	readonly	Lists the types of files that can be placed.
polygonPreferences	PolygonPreference	readonly	Polygon preference properties to use to define default settings for creating a polygon.
printerPresets	PrinterPresets	readonly	A collection of printer presets.
properties	Object	r/w	A property that allows setting of several properties at the same time.
redoHistory	Array of string	readonly	The names of the items in the redo stack.
redoName	string	readonly	The name of the action on the top of the redo stack.
scriptArgs	ScriptArg	readonly	Arguments to pass to a script.
scriptMenuActions	ScriptMenuActions	readonly	A collection of script menu actions.
scriptPreferences	ScriptPreference	readonly	Script preferences.
selection	Array of Object	r/w	The selected object(s). Can also accept: Object or NothingEnum enumerator.
spellPreferences	SpellPreference	readonly	Spell-check preferences.
storyExportPreferences	StoryExportPreference	readonly	Story export preference settings.
storyPreferences	StoryPreference	readonly	Story preference settings.
storyWindows	StoryWindows	readonly	A collection of story windows.
stripedStrokeStyles	StripedStrokeStyles	readonly	A collection of striped stroke styles.
strokeStyles	StrokeStyles	readonly	A collection of stroke styles.
svgExportPreferences	SVGExportPreference	readonly	SVG export preferences.
swatches	Swatches	readonly	A collection of swatches.
tableStyleGroups	TableStyleGroups	readonly	A collection of table style groups.
tableStyles	TableStyles	readonly	A collection of table styles.
taggedTextExportPreferences	TaggedTextExportPreference	readonly	Tagged text export preferences.
taggedTextImportPreferences	TaggedTextImportPreference	readonly	Tagged text import preferences.
textDefaults	TextDefault	readonly	Text default settings.
textEditingPreferences	TextEditingPreference	readonly	Text editing preference settings.
textExportPreferences	TextExportPreference	readonly	Text export preferences.
textFramePreferences	TextFramePreference	readonly	Text frame preference settings.
textImportPreferences	TextImportPreference	readonly	Text import preferences.
textPreferences	TextPreference	readonly	Text preference settings.
textVariables	TextVariables	readonly	A collection of text variables.
tints	Tints	readonly	A collection of tints.
transformationMatrices	TransformationMatrices	readonly	transformation matrices
transformPreferences	TransformPreference	readonly	Transform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing.
transparencyPreferences	TransparencyPreference	readonly	Transparency preference settings.
trapPresets	TrapPresets	readonly	A collection of trap presets.
undoHistory	Array of string	readonly	The names of the items in the undo stack.
undoName	string	readonly	The name of the action on the top of the undo stack.
unusedSwatches	Array of Swatch	readonly	The swatches that are not being used.
userColor	any	r/w	The color assigned to the tracked changes and notes created by the user, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
userDictionaries	UserDictionaries	readonly	A collection of user dictionaries.
userName	string	r/w	The user associated with the tracked changes and notes.
version	string	readonly	The application version.
viewPreferences	ViewPreference	readonly	View preference settings.
visible	bool	readonly	If true, the Application is visible.
windows	Windows	readonly	A collection of windows.
wordRTFImportPreferences	WordRTFImportPreference	readonly	Word and RTF import preferences.
xmlExportMaps	XMLExportMaps	readonly	A collection of XML export maps.
xmlExportPreferences	XMLExportPreference	readonly	XML export preference settings.
xmlImportMaps	XMLImportMaps	readonly	A collection of XML import maps.
xmlImportPreferences	XMLImportPreference	readonly	XML import preference settings.
xmlPreferences	XMLPreference	readonly	The XML preference settings.
xmlRuleProcessors	XMLRuleProcessors	readonly	A collection of XML rule processors.
xmlTags	XMLTags	readonly	A collection of XML tags.
xmlViewPreferences	XMLViewPreference	readonly	XML view preference settings.

Methods

void activate ()
Makes the application the front-most or active window.

EventListener addEventListener (eventType: string, handler: any[, 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	If true, the handler is called only in the capturing phase of event propagation. If false, the handler is called in the bubbling phase if this Application is an ancestor of the target, or in the at-target phase if this Application is itself the target of the event. (Optional) (default: false)

void applyMenuCustomization ([name: string])
Applies the specified menu customization set.

Parameter	Type	Description
name	string	The menu customization set. (Optional)

void applyWorkspace ([name: string])
Applies the specified workspace.

Parameter	Type	Description
name	string	The workspace. (Optional)

void cascadeWindows ()
Cascades all document windows.

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void copy ()
Copies the selection in the active document window to the clipboard.

void cut ()
Cuts the selection in the active document window and stores it in the clipboard.

void deleteFindChangeQuery (queryName: string, searchMode: SearchModes)
Deletes the specified find/change query.

Parameter	Type	Description
queryName	string	The query to delete.
searchMode	SearchModes : TEXT_SEARCH GREP_SEARCH GLYPH_SEARCH OBJECT_SEARCH	The search mode.

void deleteUnusedTags ()
Deletes unused XML markup tags.

any doScript (script: any[, language: ScriptLanguage=UNKNOWN][, withArguments: Array of any])
Executes the script in the specified language.

Parameter	Type	Description
script	File String	The script to execute. Can accept: File or String.
language	ScriptLanguage : UNKNOWN VISUAL_BASIC JAVASCRIPT	The language of the script to execute. If not specified, uses the language used to call this method. (Optional) (default: UNKNOWN)
withArguments	Array of any	An array of arguments to pass to the script. (Optional)

void exportPresets (format: ExportPresetFormat, to: File[, versionComments: string][, forceSave: bool=false])
Export the presets to a file.

Parameter	Type	Description
format	ExportPresetFormat : PDF_EXPORT_PRESETS_FORMAT PRINTER_PRESETS_FORMAT FLATTENER_PRESETS_FORMAT DOCUMENT_PRESETS_FORMAT	The preset format.
to	File	The file to export to.
versionComments	string	The comments for this version. (Optional)
forceSave	bool	Forcibly save a version. (Optional) (default: false)

void exportStrokeStyles (to: File, strokeStyleList: Array of StrokeStyle[, versionComments: string][, forceSave: bool=false])
Export the given stroke styles or presets

Parameter	Type	Description
to	File	The file to save to
strokeStyleList	Array of StrokeStyle	The list of stroke styles to save
versionComments	string	The comment for this version (Optional)
forceSave	bool	Forcibly save a version (Optional) (default: false)

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

Parameter	Type	Description
key	string	The key.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of string findKeyStrings (for: string)
Returns the locale-independent string(s) from the internal string localization database that correspond to the specified string (in the current locale).

Parameter	Type	Description
for	string	The string to search for.

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

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

Color importAdobeSwatchbookProcessColor (name: string)
Imports a process color swatch from a preloaded Adobe color book.

Parameter	Type	Description
name	string	The process color to load.

Color importAdobeSwatchbookSpotColor (name: string)
Imports a spot color swatch from an Adobe color book.

Parameter	Type	Description
name	string	The spot color to load.

void importFile (format: ExportPresetFormat, from: File)
Imports presets from the specified file.

Parameter	Type	Description
format	ExportPresetFormat : PDF_EXPORT_PRESETS_FORMAT PRINTER_PRESETS_FORMAT FLATTENER_PRESETS_FORMAT DOCUMENT_PRESETS_FORMAT	The type of preset to import.
from	File	The file to import presets from.

void importStyles (format: ImportFormat, from: File[, globalStrategy: GlobalClashResolutionStrategy=LOAD_ALL_WITH_OVERWRITE])
Imports the specified styles or presets.

Parameter	Type	Description
format	ImportFormat : CHARACTER_STYLES_FORMAT PARAGRAPH_STYLES_FORMAT TEXT_STYLES_FORMAT TOC_STYLES_FORMAT OBJECT_STYLES_FORMAT STROKE_STYLES_FORMAT TABLE_STYLES_FORMAT CELL_STYLES_FORMAT TABLE_AND_CELL_STYLES_FORMAT	The types of styles or presets to import.
from	File	The file whose styles or presets to import.
globalStrategy	GlobalClashResolutionStrategy : LOAD_ALL_WITH_OVERWRITE LOAD_ALL_WITH_RENAME DO_NOT_LOAD_THE_STYLE	The resolution strategy to employ for imported styles or presets that have the same name as existing items. (Optional) (default: LOAD_ALL_WITH_OVERWRITE)

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.

void loadFindChangeQuery (queryName: string, searchMode: SearchModes)
Loads the specified find/change query.

Parameter	Type	Description
queryName	string	The query to load.
searchMode	SearchModes : TEXT_SEARCH GREP_SEARCH GLYPH_SEARCH OBJECT_SEARCH	The search mode.

void loadSwatches (from: File)
Load swatches from the specified file.

Parameter	Type	Description
from	File	The swatch file.

void loadXMLTags (from: File)
Loads a set of XML markup tags from the specified file.

Parameter	Type	Description
from	File	The path to the file that contains the tags.

any open (from: any[, showingWindow: bool=true])
Opens the specified document, book, or library.

Parameter	Type	Description
from	File Array of Files	The file path(s) to the document, book, or library. Can accept: File or Array of Files.
showingWindow	bool	If true, displays the document, book, or library. (Optional) (default: true)

void paste ()
Pastes data from the clipboard into the active document window.

void pasteInPlace ()
Pastes data from the clipboard into the active document window at the same position that the data held in its original document.

void pasteInto ()
Pastes data from the clipboard into the selected object in the active document window.

void pasteWithoutFormatting ()
Pastes data (minus formatting) from the clipboard into the active document window.

void place (fileName: any[, showingOptions: bool=false][, withProperties: Object])
Places the file following the behavior of the place menu item.

Parameter	Type	Description
fileName	File Array of Files	One or more files to place. Can accept: File or Array of Files.
showingOptions	bool	Whether to display the import options dialog (Optional) (default: false)
withProperties	Object	Initial values for properties of the new Application (Optional)

void print (from: any[, printDialog: bool][, using: any])
Prints the specified file(s).

Parameter	Type	Description
from	File Array of Files	One or more file paths. Can accept: File or Array of Files.
printDialog	bool	Whether to invoke the print dialog (Optional)
using	PrinterPresetTypes PrinterPreset	Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

void quit ([saving: SaveOptions=ASK])
Quits the application.

Parameter	Type	Description
saving	SaveOptions : NO ASK YES	The option to use for saving changes to open documents before quitting. (Optional) (default: ASK)

void redo ()
Redoes the last action.

bool removeEventListener (eventType: string, handler: any[, 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	If true, the handler was to respond only in the capture phase. (Optional) (default: false)

void saveFindChangeQuery (queryName: string, searchMode: SearchModes)
Saves the specified find/change query.

Parameter	Type	Description
queryName	string	The query to save.
searchMode	SearchModes : TEXT_SEARCH GREP_SEARCH GLYPH_SEARCH OBJECT_SEARCH	The search mode.

void saveSwatches (to: File, swatchList: Array of Swatch[, versionComments: string][, forceSave: bool=false])
Saves the specified swatch(es) to a swatchbook file.

Parameter	Type	Description
to	File	The swatchbook file to save to.
swatchList	Array of Swatch	The swatch(es) to save.
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

void saveXMLTags (to: File[, versionComments: string][, forceSave: bool=false])
Saves a set of tags to an external file.

Parameter	Type	Description
to	File	The full path to the file in which to save the tags.
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

void select (selectableItems: any[, existingSelection: SelectionOptions=REPLACE_WITH])
Selects the specified object(s).

Parameter	Type	Description
selectableItems	Object Array of Objects NothingEnum SelectAll	The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection	SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH	The selection status of the Application in relation to previously selected objects. (Optional) (default: REPLACE_WITH)

void tileWindows ([orientation: HorizontalOrVertical=VERTICAL])
Tile all document windows

Parameter	Type	Description
orientation	HorizontalOrVertical : HORIZONTAL VERTICAL	The preferred window tiling orientation. (Optional) (default: VERTICAL)

string toSource ()
Generates a string which, if executed, will return the Application.

string toSpecifier ()
Retrieves the object specifier.

string translateKeyString (for: string)
Translate key string into localized form based on current application locale

Parameter	Type	Description
for	string	The key string that needs to be translated

void undo ()
Undoes the last action.

void updateFonts ()
Forces a check for new fonts in the various Fonts folders.

Element of:

Returned by:

Array of Application Application.getElements ( )

Properties

Methods

Element of:

Returned by:

Classes

Enumerations