Application

The application.

Methods:

activate, addEventListener, applyMenuCustomization, applyWorkspace, cascadeWindows, changeGlyph, changeGrep, changeObject, changeText, copy, cut, deleteFindChangeQuery, deleteUnusedTags, doScript, exportPresets, exportStrokeStyles, extractLabel, findGlyph, findGrep, findKeyStrings, findObject, findText, getElements, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importFile, importStyles, insertLabel, loadFindChangeQuery, loadSwatches, loadXMLTags, open, paste, pasteInPlace, pasteInto, pasteWithoutFormatting, place, print, quit, redo, removeEventListener, saveFindChangeQuery, saveSwatches, saveXMLTags, select, tileWindows, toSource, toSpecifier, translateKeyString, undo, updateFonts

Objects:

AlignDistributePreference, AnchoredObjectDefault, AnchoredObjectSetting, AutoCorrectPreference, AutoCorrectTables, BaselineFrameGridOption, Book, Books, Boolean, ButtonPreference, CellStyle, CellStyleGroups, CellStyles, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, CharacterStyle, CharacterStyleGroups, CharacterStyles, ClipboardPreference, ColorSetting, Colors, DashedStrokeStyles, DataMergeOption, Dialogs, DictionaryPreference, DisplayPerformancePreference, DisplaySettings, Document, DocumentPreference, DocumentPresets, Documents, DottedStrokeStyles, EPSExportPreference, EPSImportPreference, EventListeners, Events, ExcelImportPreference, ExportForWebPreference, FeatureSetOptions, File, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FlattenerPresets, Fonts, FootnoteOption, FrameFittingOption, GalleyPreference, GeneralPreference, GrabberPreference, Gradients, GridPreference, GuidePreference, IMEPreference, ImageIOPreference, ImagePreference, ImportedPageAttribute, InCopyExportOption, InCopyUIColors, IndexOptions, IndexingSortOptions, Inks, JPEGExportPreference, LanguagesWithVendors, LayoutAdjustmentPreference, LayoutWindow, LayoutWindows, Libraries, Locale, MarginPreference, MenuActions, Menus, MixedInkGroups, MixedInks, NotePreference, NothingEnum, NumberingLists, Object, ObjectStyle, ObjectStyleGroups, ObjectStyles, PDFExportPreference, PDFExportPresets, PDFPlacePreference, PageItemDefault, Panels, ParagraphStyle, ParagraphStyleGroups, ParagraphStyles, PasteboardPreference, PolygonPreference, PrinterPresets, SVGExportPreference, ScriptArg, ScriptMenuActions, ScriptPreference, SpellPreference, StoryExportPreference, StoryPreference, StoryWindow, StoryWindows, String, StripedStrokeStyles, StrokeStyles, Swatch, Swatches, TableStyle, TableStyleGroups, TableStyles, TaggedTextExportPreference, TaggedTextImportPreference, TextDefault, TextEditingPreference, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextVariables, Tints, TransformPreference, TransformationMatrices, TransparencyPreference, TrapPresets, UserDictionaries, ViewPreference, Window, Windows, WordRTFImportPreference, XMLExportMaps, XMLExportPreference, XMLImportMaps, XMLImportPreference, XMLPreference, XMLRuleProcessors, XMLTags, XMLViewPreference

Preferences:

AlignDistributePreference, AutoCorrectPreference, BaselineFrameGridOption, ButtonPreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, ClipboardPreference, DataMergeOption, DictionaryPreference, DisplayPerformancePreference, DocumentPreference, EPSExportPreference, EPSImportPreference, ExcelImportPreference, ExportForWebPreference, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FootnoteOption, FrameFittingOption, GalleyPreference, GeneralPreference, GrabberPreference, GridPreference, GuidePreference, IMEPreference, ImageIOPreference, ImagePreference, InCopyExportOption, IndexOptions, IndexingSortOptions, JPEGExportPreference, LayoutAdjustmentPreference, MarginPreference, NotePreference, NothingEnum, PDFExportPreference, PDFPlacePreference, PasteboardPreference, PolygonPreference, SVGExportPreference, ScriptPreference, SpellPreference, StoryExportPreference, StoryPreference, TaggedTextExportPreference, TaggedTextImportPreference, TextEditingPreference, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TransformPreference, TransparencyPreference, ViewPreference, WordRTFImportPreference, XMLExportPreference, XMLImportPreference, XMLPreference, XMLViewPreference

Property Listing

Property

Type

Access

Description

activeBook

Book

read/write

The active book.

activeDocument

Document

read/write

The front-most document.

activeScript

File

readonly

The current script running from the Scripts panel.

activeWindow

LayoutWindow

Window

StoryWindow

read/write

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 AutoCorrectTable

readonly

A collection of auto-correct tables.

baselineFrameGridOptions

BaselineFrameGridOption

readonly

Baseline frame grid option settings.

books

Books Book

readonly

A collection of books.

buttonPreferences

ButtonPreference

readonly

Button preference settings.

cellStyleGroups

CellStyleGroups CellStyleGroup

readonly

A collection of cell style groups.

cellStyles

CellStyles CellStyle

readonly

A collection of cell styles.

changeGlyphPreferences

ChangeGlyphPreference

NothingEnum.NOTHING

read/write

Change glyph preferences. Can also accept: NothingEnum enumerator.

changeGrepPreferences

ChangeGrepPreference

NothingEnum.NOTHING

read/write

Change grep preferences. Can also accept: NothingEnum enumerator.

changeObjectPreferences

ChangeObjectPreference

NothingEnum.NOTHING

read/write

Change object preferences. Can also accept: NothingEnum enumerator.

changeTextPreferences

ChangeTextPreference

NothingEnum.NOTHING

read/write

Change text preferences. Can also accept: NothingEnum enumerator.

characterStyleGroups

CharacterStyleGroups CharacterStyleGroup

readonly

A collection of character style groups.

characterStyles

CharacterStyles CharacterStyle

readonly

A collection of character styles.

clearOverridesWhenApplyingStyle

Boolean

read/write

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.

colorSettings

ColorSetting

readonly

Color setting properties that define color management defaults.

colors

Colors Color

readonly

A collection of colors.

dashedStrokeStyles

DashedStrokeStyles DashedStrokeStyle

readonly

A collection of dashed stroke styles.

dataMergeOptions

DataMergeOption

readonly

The data merge option properties that define the data merge.

dialogs

Dialogs Dialog

readonly

A collection of dialogs.

dictionaryPreferences

DictionaryPreference

readonly

User dictionary preference settings.

displayPerformancePreferences

DisplayPerformancePreference

readonly

Display performance settings.

displaySettings

DisplaySettings DisplaySetting

readonly

Display setting properties.

documentPreferences

DocumentPreference

readonly

Document preference settings.

documentPresets

DocumentPresets DocumentPreset

readonly

A collection of document presets.

documents

Documents Document

readonly

A collection of documents.

dottedStrokeStyles

DottedStrokeStyles DottedStrokeStyle

readonly

A collection of dotted stroke styles.

epsExportPreferences

EPSExportPreference

readonly

EPS export preferences.

epsImportPreferences

EPSImportPreference

readonly

EPS import preferences.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

excelImportPreferences

ExcelImportPreference

readonly

Excel import preferences.

exportForWebPreferences

ExportForWebPreference

readonly

The default export for web preferences.

featureSet

FeatureSetOptions

FeatureSetOptions.JAPANESE

FeatureSetOptions.ROMAN

readonly

The feature set.

filePath

File

readonly

The full path to the file.

findChangeGlyphOptions

FindChangeGlyphOption

NothingEnum.NOTHING

read/write

Find/change glyph options. Can also accept: NothingEnum enumerator.

findChangeGrepOptions

FindChangeGrepOption

NothingEnum.NOTHING

read/write

Find/change grep options. Can also accept: NothingEnum enumerator.

findChangeObjectOptions

FindChangeObjectOption

NothingEnum.NOTHING

read/write

Find/change object options. Can also accept: NothingEnum enumerator.

findChangeTextOptions

FindChangeTextOption

NothingEnum.NOTHING

read/write

Find/change text options. Can also accept: NothingEnum enumerator.

findGlyphPreferences

FindGlyphPreference

NothingEnum.NOTHING

read/write

Find glyph preferences. Can also accept: NothingEnum enumerator.

findGrepPreferences

FindGrepPreference

NothingEnum.NOTHING

read/write

Find grep preferences. Can also accept: NothingEnum enumerator.

findObjectPreferences

FindObjectPreference

NothingEnum.NOTHING

read/write

Find object preferences. Can also accept: NothingEnum enumerator.

findTextPreferences

FindTextPreference

NothingEnum.NOTHING

read/write

Find text preferences. Can also accept: NothingEnum enumerator.

flattenerPresets

FlattenerPresets FlattenerPreset

readonly

A collection of transparency flattener presets.

fonts

Fonts Font

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 Gradient

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 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 IndexingSortOption

readonly

A collection of indexing sort options.

inks

Inks Ink

readonly

A collection of inks.

jpegExportPreferences

JPEGExportPreference

readonly

JPEG export preferences.

label

String

read/write

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 LayoutWindow

readonly

A collection of layout windows.

libraries

Libraries Library

readonly

A collection of object libraries.

locale

Locale

Locale.ARABIC_LOCALE

Locale.CZECH_LOCALE

Locale.DANISH_LOCALE

Locale.ENGLISH_LOCALE

Locale.FINNISH_LOCALE

Locale.FRENCH_LOCALE

Locale.GERMAN_LOCALE

Locale.GREEK_LOCALE

Locale.HEBREW_LOCALE

Locale.HUNGARIAN_LOCALE

Locale.INTERNATIONAL_ENGLISH_LOCALE

Locale.ITALIAN_LOCALE

Locale.JAPANESE_LOCALE

Locale.POLISH_LOCALE

Locale.PORTUGUESE_LOCALE

Locale.ROMANIAN_LOCALE

Locale.RUSSIAN_LOCALE

Locale.SPANISH_LOCALE

Locale.SWEDISH_LOCALE

Locale.TURKISH_LOCALE

Locale.UKRAINIAN_LOCALE

readonly

The locale of the application.

marginPreferences

MarginPreference

readonly

Margin preference settings.

menuActions

MenuActions MenuAction

readonly

A collection of menu actions.

menus

Menus Menu

readonly

A collection of menus.

mixedInkGroups

MixedInkGroups MixedInkGroup

readonly

A collection of mixed ink groups.

mixedInks

MixedInks MixedInk

readonly

A collection of mixed inks.

modalState

Boolean

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 NumberingList

readonly

A collection of numbered lists.

objectStyleGroups

ObjectStyleGroups ObjectStyleGroup

readonly

A collection of object style groups.

objectStyles

ObjectStyles ObjectStyle

readonly

A collection of object styles.

pageItemDefaults

PageItemDefault

readonly

The default page item formatting for the Application.

panels

Panels Panel

readonly

A collection of panels.

paragraphStyleGroups

ParagraphStyleGroups ParagraphStyleGroup

readonly

A collection of paragraph style groups.

paragraphStyles

ParagraphStyles ParagraphStyle

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 PDFExportPreset

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 PrinterPreset

readonly

A collection of printer presets.

properties

Object

read/write

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 ScriptMenuAction

readonly

A collection of script menu actions.

scriptPreferences

ScriptPreference

readonly

Script preferences.

selection

Array of Object

NothingEnum.NOTHING

read/write

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 StoryWindow

readonly

A collection of story windows.

stripedStrokeStyles

StripedStrokeStyles StripedStrokeStyle

readonly

A collection of striped stroke styles.

strokeStyles

StrokeStyles StrokeStyle

readonly

A collection of stroke styles.

svgExportPreferences

SVGExportPreference

readonly

SVG export preferences.

swatches

Swatches

readonly

A collection of swatches.

tableStyleGroups

TableStyleGroups TableStyleGroup

readonly

A collection of table style groups.

tableStyles

TableStyles TableStyle

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 TextVariable

readonly

A collection of text variables.

tints

Tints Tint

readonly

A collection of tints.

transformPreferences

TransformPreference

readonly

Transform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing.

transformationMatrices

TransformationMatrices

readonly

A collection of transformation matrices.

transparencyPreferences

TransparencyPreference

readonly

Transparency preference settings.

trapPresets

TrapPresets TrapPreset

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

Array of 3 Reals (0 - 255)

InCopyUIColors

read/write

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 UserDictionary

readonly

A collection of user dictionaries.

userName

String

read/write

The user associated with the tracked changes and notes.

version

String

readonly

The application version.

viewPreferences

ViewPreference

readonly

View preference settings.

visible

Boolean

readonly

If true, the Application is visible.

windows

Windows Window

readonly

A collection of windows.

wordRTFImportPreferences

WordRTFImportPreference

readonly

Word and RTF import preferences.

xmlExportMaps

XMLExportMaps XMLExportMap

readonly

A collection of XML export maps.

xmlExportPreferences

XMLExportPreference

readonly

XML export preference settings.

xmlImportMaps

XMLImportMaps XMLImportMap

readonly

A collection of XML import maps.

xmlImportPreferences

XMLImportPreference

readonly

XML import preference settings.

xmlPreferences

XMLPreference

readonly

The XML preference settings.

xmlRuleProcessors

XMLRuleProcessors XMLRuleProcessor

readonly

A collection of XML rule processors.

xmlTags

XMLTags XMLTag

readonly

A collection of XML tags.

xmlViewPreferences

XMLViewPreference

readonly

XML view preference settings.

Method Listing

undefined activate ()

Makes the application the front-most or active window.

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined applyMenuCustomization (name:String)

Applies the specified menu customization set. An empty string will reset all menus and colorization (Show Full Menus). No string will apply the default menu set.

Parameter

Type

Description

name

String

The menu customization set. (Optional)

undefined applyWorkspace (name:String)

Applies the specified workspace.

Parameter

Type

Description

name

String

The workspace. (Optional)

undefined cascadeWindows ()

Cascades all document windows.

Text changeGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeGrep (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

PageItem changeObject (reverseOrder:Boolean)

Finds objects that match the find what value and replace the objects with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text changeText (reverseOrder:Boolean)

Finds text that matches the find what value and replaces the text with the change to value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

undefined copy ()

Copies the selection in the active document window to the clipboard.

undefined cut ()

Cuts the selection in the active document window and stores it in the clipboard.

undefined deleteFindChangeQuery (queryName:String, searchMode:SearchModes)

Deletes the specified find/change query.

Parameter

Type

Description

queryName

String

The query to delete.

searchMode

SearchModes

SearchModes.GLYPH_SEARCH

SearchModes.GREP_SEARCH

SearchModes.OBJECT_SEARCH

SearchModes.TEXT_SEARCH

The search mode.

undefined deleteUnusedTags ()

Deletes unused XML markup tags.

Varies doScript (script:Varies File String, [language:ScriptLanguage=ScriptLanguage], withArguments:Array of Varies)

Executes the script in the specified language.

Parameter

Type

Description

script

File

String

The script to execute. Can accept: File or String.

language

ScriptLanguage

ScriptLanguage.UNKNOWN

ScriptLanguage.JAVASCRIPT

ScriptLanguage.UXPSCRIPT

ScriptLanguage.APPLESCRIPT_LANGUAGE

ScriptLanguage.APPLESCRIPT_LANGUAGE

The language of the script to execute. If not specified, uses the language used to call this method. (Optional)

(default: ScriptLanguage.UNKNOWN)

withArguments

Array of Varies

An array of arguments to pass to the script. (Optional)

undefined exportPresets (format:ExportPresetFormat, to:File, versionComments:String, [forceSave:Boolean=Boolean])

Export the presets to a file.

Parameter

Type

Description

format

ExportPresetFormat

ExportPresetFormat.DOCUMENT_PRESETS_FORMAT

ExportPresetFormat.FLATTENER_PRESETS_FORMAT

ExportPresetFormat.PDF_EXPORT_PRESETS_FORMAT

ExportPresetFormat.PRINTER_PRESETS_FORMAT

The preset format.

to

File

The file to export to.

versionComments

String

The comments for this version. (Optional)

forceSave

Boolean

Forcibly save a version. (Optional)

(default: false)

undefined exportStrokeStyles (to:File, strokeStyleList:Array of StrokeStyle, versionComments:String, [forceSave:Boolean=Boolean])

Exports 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

Boolean

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.

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findGrep (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

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.

PageItem findObject (reverseOrder:Boolean)

Finds objects that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

Text findText (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

If true, returns the results in reverse order. (Optional)

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.

undefined importFile (format:ExportPresetFormat, from:File)

Imports presets from the specified file.

Parameter

Type

Description

format

ExportPresetFormat

ExportPresetFormat.DOCUMENT_PRESETS_FORMAT

ExportPresetFormat.FLATTENER_PRESETS_FORMAT

ExportPresetFormat.PDF_EXPORT_PRESETS_FORMAT

ExportPresetFormat.PRINTER_PRESETS_FORMAT

The type of preset to import.

from

File

The file to import presets from.

undefined importStyles (format:ImportFormat, from:File, [globalStrategy:GlobalClashResolutionStrategy=GlobalClashResolutionStrategy])

Imports the specified styles.

Parameter

Type

Description

format

ImportFormat

ImportFormat.CELL_STYLES_FORMAT

ImportFormat.CHARACTER_STYLES_FORMAT

ImportFormat.OBJECT_STYLES_FORMAT

ImportFormat.PARAGRAPH_STYLES_FORMAT

ImportFormat.STROKE_STYLES_FORMAT

ImportFormat.TABLE_AND_CELL_STYLES_FORMAT

ImportFormat.TABLE_STYLES_FORMAT

ImportFormat.TEXT_STYLES_FORMAT

ImportFormat.TOC_STYLES_FORMAT

The types of styles to import.

from

File

The file containing the styles you want to import.

globalStrategy

GlobalClashResolutionStrategy

GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE

GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE

GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME

The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional)

(default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE)

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

undefined loadFindChangeQuery (queryName:String, searchMode:SearchModes)

Loads the specified find/change query.

Parameter

Type

Description

queryName

String

The query to load.

searchMode

SearchModes

SearchModes.GLYPH_SEARCH

SearchModes.GREP_SEARCH

SearchModes.OBJECT_SEARCH

SearchModes.TEXT_SEARCH

The search mode.

undefined loadSwatches (from:File)

Load swatches from the specified file.

Parameter

Type

Description

from

File

The swatch file or InDesign document.

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

Varies open (from:Array of Varies File Files., [showingWindow:Boolean=Boolean])

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

Boolean

If true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional)

(default: true)

undefined paste ()

Pastes data from the clipboard into the active document window.

undefined pasteInPlace ()

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

undefined pasteInto ()

Pastes data from the clipboard into the selected object in the active document window.

undefined pasteWithoutFormatting ()

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

undefined place (fileName:Array of Varies File Files., [showingOptions:Boolean=Boolean], withProperties:Object)

Place one or more files following the behavior of the place menu item. This may load the place gun or replace the selected object, depending on current preferences.

Parameter

Type

Description

fileName

File

Array of Files.

One or more files to place. Can accept: File or Array of Files.

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

undefined print (from:Array of Varies File Files., printDialog:Boolean, using:Varies PrinterPresetTypes PrinterPreset)

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

Boolean

Whether to invoke the print dialog (Optional)

using

PrinterPresetTypes

PrinterPresetTypes.CUSTOM

PrinterPresetTypes.DEFAULT_VALUE

PrinterPreset

Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

undefined quit ([saving:SaveOptions=SaveOptions])

Quits the application.

Parameter

Type

Description

saving

SaveOptions

SaveOptions.ASK

SaveOptions.NO

SaveOptions.YES

The option to use for saving changes to open documents before quitting. (Optional)

(default: SaveOptions.ASK)

undefined redo ()

Redoes the last action.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined saveFindChangeQuery (queryName:String, searchMode:SearchModes)

Saves the specified find/change query.

Parameter

Type

Description

queryName

String

The query to save.

searchMode

SearchModes

SearchModes.GLYPH_SEARCH

SearchModes.GREP_SEARCH

SearchModes.OBJECT_SEARCH

SearchModes.TEXT_SEARCH

The search mode.

undefined saveSwatches (to:File, swatchList:Array of Swatch, versionComments:String, [forceSave:Boolean=Boolean])

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

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

undefined saveXMLTags (to:File, versionComments:String, [forceSave:Boolean=Boolean])

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

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

undefined select (selectableItems:Array of Varies Objects NothingEnum Object SelectAll, [existingSelection:SelectionOptions=SelectionOptions])

Selects the specified object(s).

Parameter

Type

Description

selectableItems

Array of Objects

NothingEnum.NOTHING

Object

SelectAll

SelectAll.ALL

The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

The selection status of the Application in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

undefined tileWindows ([orientation:HorizontalOrVertical=HorizontalOrVertical])

Tile all document windows

Parameter

Type

Description

orientation

HorizontalOrVertical

HorizontalOrVertical.HORIZONTAL

HorizontalOrVertical.VERTICAL

The preferred window tiling orientation. (Optional)

(default: HorizontalOrVertical.VERTICAL)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

String translateKeyString (for:String)

Translates a key string into localized form based on current application locale.

Parameter

Type

Description

for

String

The key string to translate

undefined undo ()

Undoes the last action.

undefined updateFonts ()

Forces a check for new fonts in the various Fonts folders.

Object of

global.app

AlignDistributePreference.parent

AnchoredObjectDefault.parent

AnchoredObjectSetting.parent

Application.parent

AutoCorrectPreference.parent

AutoCorrectTable.parent

BaselineFrameGridOption.parent

Book.parent

ButtonPreference.parent

CellStyle.parent

CellStyleGroup.parent

ChangeGlyphPreference.parent

ChangeGrepPreference.parent

ChangeObjectPreference.parent

ChangeTextPreference.parent

CharacterStyle.parent

CharacterStyleGroup.parent

ClipboardPreference.parent

Color.parent

ColorSetting.parent

DashedStrokeStyle.parent

DataMergeOption.parent

Dialog.parent

DictionaryPreference.parent

DisplayPerformancePreference.parent

DisplaySetting.parent

Document.parent

DocumentEvent.parent

DocumentPreference.parent

DocumentPreset.parent

DottedStrokeStyle.parent

EPSExportPreference.parent

EPSImportPreference.parent

Event.parent

EventListener.parent

ExcelImportPreference.parent

ExportForWebPreference.parent

FindChangeGlyphOption.parent

FindChangeGrepOption.parent

FindChangeObjectOption.parent

FindChangeTextOption.parent

FindGlyphPreference.parent

FindGrepPreference.parent

FindObjectPreference.parent

FindTextPreference.parent

FlattenerPreset.parent

Font.parent

FootnoteOption.parent

FrameFittingOption.parent

GalleyPreference.parent

GeneralPreference.parent

GrabberPreference.parent

Gradient.parent

GridPreference.parent

GuidePreference.parent

IMEPreference.parent

ImageIOPreference.parent

ImagePreference.parent

ImportExportEvent.parent

ImportedPageAttribute.parent

InCopyExportOption.parent

IndexOptions.parent

IndexingSortOption.parent

Ink.parent

JPEGExportPreference.parent

LanguageWithVendors.parent

LayoutAdjustmentPreference.parent

LayoutWindow.parent

Library.parent

LibraryPanel.parent

MarginPreference.parent

Menu.parent

MenuAction.parent

MixedInk.parent

MixedInkGroup.parent

NotePreference.parent

NumberingList.parent

ObjectStyle.parent

ObjectStyleGroup.parent

PDFExportPreference.parent

PDFExportPreset.parent

PDFPlacePreference.parent

PageItemDefault.parent

PagesPanel.parent

Panel.parent

ParagraphStyle.parent

ParagraphStyleGroup.parent

PasteboardPreference.parent

PolygonPreference.parent

PrinterPreset.parent

SVGExportPreference.parent

ScriptArg.parent

ScriptMenuAction.parent

ScriptPreference.parent

SpellPreference.parent

StoryExportPreference.parent

StoryPreference.parent

StoryWindow.parent

StripedStrokeStyle.parent

StrokeStyle.parent

Swatch.parent

TableStyle.parent

TableStyleGroup.parent

TaggedTextExportPreference.parent

TaggedTextImportPreference.parent

TextDefault.parent

TextEditingPreference.parent

TextExportPreference.parent

TextFramePreference.parent

TextImportPreference.parent

TextPreference.parent

TextVariable.parent

TextWrapPreference.parent

Tint.parent

TransformPreference.parent

TransformationMatrix.parent

TransparencyPreference.parent

TrapPreset.parent

UserDictionary.parent

ViewPreference.parent

Window.parent

WordRTFImportPreference.parent

XMLExportMap.parent

XMLExportPreference.parent

XMLImportMap.parent

XMLImportPreference.parent

XMLPreference.parent

XMLRuleProcessor.parent

XMLTag.parent

XMLViewPreference.parent

Return

Application.getElements()