Class

Application

 The application.

QuickLinks

activate, addEventListener, applyMenuCustomization, applyShortcutSet, applyWorkspace, cancelAllTasks, cascadeWindows, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, clearFrameFittingOptions, copy, cut, deleteFindChangeQuery, deleteUnusedTags, doScript, dumpBetweenMemoryMarks, dumpFromMemoryMark, exportPresets, exportStrokeStyles, extractLabel, findGlyph, findGrep, findKeyStrings, findObject, findText, findTransliterate, generateIDMLSchema, getElements, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importFile, importStyles, insertLabel, loadConditions, loadFindChangeQuery, loadMotionPreset, loadPreflightProfile, loadSwatches, loadXMLTags, memoryStatistics, mountProject, open, packageUCF, paste, pasteInPlace, pasteInto, pasteWithoutFormatting, performanceMetric, performanceMetricLongName, performanceMetricShortName, place, print, quit, redo, removeEventListener, saveFindChangeQuery, saveSwatches, saveXMLTags, select, setApplicationPreferences, tileWindows, toSource, toSpecifier, togglePanelSystemVisibility, translateKeyString, undo, unpackageUCF, updateFonts, waitForAllTasks

Hierarchy

Application
Application
AlignDistributePreference | AnchoredObjectDefault | AnchoredObjectSetting | Application | AutoCorrectPreference | AutoCorrectTable | BackgroundTask | BaselineFrameGridOption | Book | ButtonPreference | CellStyle | CellStyleGroup | CellStyleMapping | ChangeGlyphPreference | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | ChangeTransliteratePreference | CharStyleMapping | CharacterStyle | CharacterStyleGroup | CjkGridPreference | ClipboardPreference | Color | ColorSetting | CompositeFont | Condition | ConditionSet | ConditionalTextPreference | ContentPlacerObject | DashedStrokeStyle | DataMergeOption | Dialog | DictionaryPreference | DisplayPerformancePreference | DisplaySetting | Document | DocumentEvent | DocumentPreference | DocumentPreset | DottedStrokeStyle | EPSExportPreference | EPSImportPreference | Event | EventListener | ExcelImportPreference | ExportForWebPreference | FindChangeGlyphOption | FindChangeGrepOption | FindChangeObjectOption | FindChangeTextOption | FindChangeTransliterateOption | FindGlyphPreference | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FlattenerPreset | Font | FontLockingPreference | FootnoteOption | FrameFittingOption | GalleyPreference | GeneralPreference | GrabberPreference | Gradient | GridPreference | GridPrintingPreference | GuidePreference | IMEPreference | IdleTask | ImageIOPreference | ImagePreference | ImportExportEvent | ImportedPageAttribute | InCopyExportOption | IndexOptions | IndexingSortOption | Ink | InteractivePDFExportPreference | JPEGExportPreference | KinsokuTable | LanguageWithVendors | LayoutAdjustmentPreference | LayoutGridDataInformation | Library | LibraryPanel | LinkedPageItemOption | LinkedStoryOption | LinkingPreference | MarginPreference | Menu | MenuAction | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | MotionPreset | MutationEvent | NamedGrid | NotePreference | NumberingList | ObjectStyle | ObjectStyleGroup | PDFExportPreference | PDFExportPreset | PDFPlacePreference | PNGExportPreference | PageItemDefault | PagesPanel | Panel | ParaStyleMapping | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | PolygonPreference | Preference | PreflightBookOption | PreflightOption | PreflightProcess | PreflightProfile | PreflightRule | PrinterPreset | SWFExportPreference | ScriptArg | ScriptMenuAction | ScriptPreference | SmartGuidePreference | SpellPreference | StoryGridDataInformation | StoryPreference | StripedStrokeStyle | StrokeFillProxySetting | StrokeStyle | Swatch | TableStyle | TableStyleGroup | TableStyleMapping | TaggedPDFPreference | TaggedTextExportPreference | TaggedTextImportPreference | TextDefault | TextEditingPreference | TextExportPreference | TextFramePreference | TextImportPreference | TextPreference | TextVariable | TextWrapPreference | Tint | ToolBox | TrackChangesPreference | TransformPreference | TransformationMatrix | TransparencyPreference | TrapPreset | UserDictionary | ViewPreference | WatermarkPreference | WordRTFImportPreference | XFLExportPreference | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLPreference | XMLRuleProcessor | XMLTag | XMLViewPreference

Properties

PropertyTypeAccessDescription
activeBookBook r/wThe active book.
activeDocumentDocument r/wThe front-most document.
activeScriptFile readonlyThe current script running from the Scripts panel.
activeScriptUndoModeUndoModes:
UndoModes.SCRIPT_REQUEST
UndoModes.ENTIRE_SCRIPT
UndoModes.AUTO_UNDO
UndoModes.FAST_ENTIRE_SCRIPT
readonlyThe undo mode for the current script execution.
activeWindowLayoutWindow
StoryWindow
Window
r/wThe front-most window. Can return: Window, LayoutWindow or StoryWindow.
alignDistributePreferencesAlignDistributePreference readonlyPreferences for alignment and distribution.
allCellStylesArray of CellStyle readonlyAll Cell styles
allCharacterStylesArray of CharacterStyle readonlyLists all character styles (regardless of their group).
allObjectStylesArray of ObjectStyle readonlyAll object styles contained by the Application.
allParagraphStylesArray of ParagraphStyle readonlyLists all paragraph styles (regardless of their group).
allPreflightObjectTypesArray of string readonlyThe list of all object types (strings) a preflight rule can operate on.
allPreflightRuleCategoriesArray of string readonlyThe list of all categories that have been declared by rules.
allPreflightRuleIDsArray of string readonlyThe list of all known (declared) rule IDs.
allTableStylesArray of TableStyle readonlyAll Table styles
anchoredObjectDefaultsAnchoredObjectDefault readonlyAnchored object default settings.
anchoredObjectSettingsAnchoredObjectSetting readonlyAnchored object settings.
autoCorrectPreferencesAutoCorrectPreference readonlyAuto-correct preferences.
autoCorrectTablesAutoCorrectTables readonlyA collection of auto-correct tables.
backgroundTasksBackgroundTasks readonlyA collection of background task objects.
baselineFrameGridOptionsBaselineFrameGridOption readonlyBaseline frame grid option settings.
booksBooks readonlyA collection of books.
buttonPreferencesButtonPreference readonlyButton preference settings.
cellStyleGroupsCellStyleGroups readonlyA collection of cell style groups.
cellStyleMappingsCellStyleMappings readonlyA collection of cell style mappings.
cellStylesCellStyles readonlyA collection of cell styles.
changeGlyphPreferencesChangeGlyphPreference
NothingEnum
r/wChange glyph preferences. Can also accept: NothingEnum enumerator.
changeGrepPreferencesChangeGrepPreference
NothingEnum
r/wChange grep preferences. Can also accept: NothingEnum enumerator.
changeObjectPreferencesChangeObjectPreference
NothingEnum
r/wChange object preferences. Can also accept: NothingEnum enumerator.
changeTextPreferencesChangeTextPreference
NothingEnum
r/wChange text preferences. Can also accept: NothingEnum enumerator.
changeTransliteratePreferencesChangeTransliteratePreference
NothingEnum
r/wChange transliterate preferences. Can also accept: NothingEnum enumerator.
charStyleMappingsCharStyleMappings readonlyA collection of char style mappings.
characterStyleGroupsCharacterStyleGroups readonlyA collection of character style groups.
characterStylesCharacterStyles readonlyA collection of character styles.
cjkGridPreferencesCjkGridPreference readonlyCJK grid preference settings.
clearOverridesWhenApplyingStylebool r/wClear overrides first before applying object style
clipboardPreferencesClipboardPreference readonlyClipboard preference properties that define the way that the application interacts with the system clipboard.
colorSettingsColorSetting readonlyColor setting properties that define color management defaults.
colorsColors readonlyA collection of colors.
compositeFontsCompositeFonts readonlyA collection of composite fonts.
conditionSetsConditionSets readonlyA collection of condition sets for conditional text.
conditionalTextPreferencesConditionalTextPreference readonlyConditional text preferences.
conditionsConditions readonlyA collection of conditions for conditional text.
contentPlacerContentPlacerObject readonlyThe Content Placer. Used to get a reference to the content placer object.
dashedStrokeStylesDashedStrokeStyles readonlyA collection of dashed stroke styles.
dataMergeOptionsDataMergeOption readonlyThe data merge option properties that define the data merge.
dialogsDialogs readonlyA collection of dialogs.
dictionaryPreferencesDictionaryPreference readonlyUser dictionary preference settings.
displayPerformancePreferencesDisplayPerformancePreference readonlyDisplay performance settings.
displaySettingsDisplaySettings readonlyDisplay setting properties.
documentPreferencesDocumentPreference readonlyDocument preference settings.
documentPresetsDocumentPresets readonlyA collection of document presets.
documentsDocuments readonlyA collection of documents.
dottedStrokeStylesDottedStrokeStyles readonlyA collection of dotted stroke styles.
epsExportPreferencesEPSExportPreference readonlyEPS export preferences.
epsImportPreferencesEPSImportPreference readonlyEPS import preferences.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
excelImportPreferencesExcelImportPreference readonlyExcel import preferences.
exportForWebPreferencesExportForWebPreference readonlyThe default export for web preferences.
featureSetFeatureSetOptions:
FeatureSetOptions.ROMAN
FeatureSetOptions.JAPANESE
FeatureSetOptions.RIGHTTOLEFT
readonlyThe feature set.
filePathFile readonlyThe full path to the file.
findChangeGlyphOptionsFindChangeGlyphOption
NothingEnum
r/wFind/change glyph options. Can also accept: NothingEnum enumerator.
findChangeGrepOptionsFindChangeGrepOption
NothingEnum
r/wFind/change grep options. Can also accept: NothingEnum enumerator.
findChangeObjectOptionsFindChangeObjectOption
NothingEnum
r/wFind/change object options. Can also accept: NothingEnum enumerator.
findChangeTextOptionsFindChangeTextOption
NothingEnum
r/wFind/change text options. Can also accept: NothingEnum enumerator.
findChangeTransliterateOptionsFindChangeTransliterateOption
NothingEnum
r/wFind/change transliterate options. Can also accept: NothingEnum enumerator.
findGlyphPreferencesFindGlyphPreference
NothingEnum
r/wFind glyph preferences. Can also accept: NothingEnum enumerator.
findGrepPreferencesFindGrepPreference
NothingEnum
r/wFind grep preferences. Can also accept: NothingEnum enumerator.
findObjectPreferencesFindObjectPreference
NothingEnum
r/wFind object preferences. Can also accept: NothingEnum enumerator.
findTextPreferencesFindTextPreference
NothingEnum
r/wFind text preferences. Can also accept: NothingEnum enumerator.
findTransliteratePreferencesFindTransliteratePreference
NothingEnum
r/wFind transliterate preferences. Can also accept: NothingEnum enumerator.
flattenerPresetsFlattenerPresets readonlyA collection of transparency flattener presets.
fontLockingPreferencesFontLockingPreference readonlyFont locking preference settings.
fontsFonts readonlyA collection of fonts.
footnoteOptionsFootnoteOption readonlyFootnote option settings.
frameFittingOptionsFrameFittingOption readonlyThe frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
fullNameFile readonlyThe full path to the Application, including the name of the Application.
galleyPreferencesGalleyPreference readonlyGalley preference settings.
generalPreferencesGeneralPreference readonlyGeneral preference settings.
grabberPreferencesGrabberPreference readonlyGrabber preference properties that define display performance quality during scrolling.
gradientsGradients readonlyA collection of gradients.
gridPreferencesGridPreference readonlyGrid preference settings.
gridPrintingPreferencesGridPrintingPreference readonlyGrid printing preference and export settings.
guidePreferencesGuidePreference readonlyGuide preference settings.
idleTasksIdleTasks readonlyAll attachable idle tasks.
imageIOPreferencesImageIOPreference readonlyThe image I/O preference properties that define preferences for importing images.
imagePreferencesImagePreference readonlyImage preferences.
imePreferencesIMEPreference readonlyIME preference settings.
importedPageAttributesImportedPageAttribute readonlyPlaced InDesign page attributes.
incopyExportOptionsInCopyExportOption readonlyExport options for InCopy INCX document format.
indexGenerationOptionsIndexOptions readonlyThe index options properties that define how an index is formatted.
indexingSortOptionsIndexingSortOptions readonlyA collection of indexing sort options.
inksInks readonlyA collection of inks.
interactivePDFExportPreferencesInteractivePDFExportPreference readonlyInteractive PDF export preferences.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
jpegExportPreferencesJPEGExportPreference readonlyJPEG export preferences.
kinsokuTablesKinsokuTables readonlyA collection of kinsoku tables.
labelstring r/wA property that can be set to any string.
languagesWithVendorsLanguagesWithVendors readonlyA collection of languages with vendors.
layoutAdjustmentPreferencesLayoutAdjustmentPreference readonlyLayout sdjustment preference settings.
layoutGridDataLayoutGridDataInformation readonlyDefault properties specific to layout grids.
layoutWindowsLayoutWindows readonlyA collection of layout windows.
librariesLibraries readonlyA collection of object libraries.
linkedPageItemOptionsLinkedPageItemOption readonlyLinked Page Item options
linkedStoryOptionsLinkedStoryOption readonlyLinked story options
linkingPreferencesLinkingPreference readonlyThe links preference properties that define preferences for links.
liveScreenDrawingLiveDrawingOptions:
LiveDrawingOptions.NEVER
LiveDrawingOptions.IMMEDIATELY
LiveDrawingOptions.DELAYED
r/wDelay before mouse operations trigger live screen drawing of page items.
localeLocale:
Locale.DANISH_LOCALE
Locale.ENGLISH_LOCALE
Locale.INTERNATIONAL_ENGLISH_LOCALE
Locale.FINNISH_LOCALE
Locale.FRENCH_LOCALE
Locale.GERMAN_LOCALE
Locale.ITALIAN_LOCALE
Locale.PORTUGUESE_LOCALE
Locale.SPANISH_LOCALE
Locale.SWEDISH_LOCALE
Locale.JAPANESE_LOCALE
Locale.ARABIC_LOCALE
Locale.CZECH_LOCALE
Locale.GREEK_LOCALE
Locale.HEBREW_LOCALE
Locale.HUNGARIAN_LOCALE
Locale.POLISH_LOCALE
Locale.ROMANIAN_LOCALE
Locale.RUSSIAN_LOCALE
Locale.TURKISH_LOCALE
Locale.UKRAINIAN_LOCALE
Locale.KOREAN_LOCALE
Locale.SIMPLIFIED_CHINESE_LOCALE
Locale.TRADITIONAL_CHINESE_LOCALE
readonlyThe locale of the application.
marginPreferencesMarginPreference readonlyMargin preference settings.
menuActionsMenuActions readonlyA collection of menu actions.
menusMenus readonlyA collection of menus.
mixedInkGroupsMixedInkGroups readonlyA collection of mixed ink groups.
mixedInksMixedInks readonlyA collection of mixed inks.
modalStatebool readonlyIf true, a modal dialog or alert is active.
mojikumiTablesMojikumiTables readonlyA collection of mojikumi tables.
mojikumiUIPreferencesMojikumiUiPreference readonlyMojikumi user interface preference settings.
motionPresetsMotionPresets readonlyA collection of Motion presets.
namestring readonlyThe name of the Application.
namedGridsNamedGrids readonlyA collection of named grids.
notePreferencesNotePreference readonlyNote preference settings.
numberingListsNumberingLists readonlyA collection of numbered lists.
objectStyleGroupsObjectStyleGroups readonlyA collection of object style groups.
objectStylesObjectStyles readonlyA collection of object styles.
pageItemDefaultsPageItemDefault readonlyThe default page item formatting for the Application.
panelsPanels readonlyA collection of panels.
paraStyleMappingsParaStyleMappings readonlyA collection of para style mappings.
paragraphStyleGroupsParagraphStyleGroups readonlyA collection of paragraph style groups.
paragraphStylesParagraphStyles readonlyA collection of paragraph styles.
parentApplication readonlyThe parent of the Application (a Application).
pasteboardPreferencesPasteboardPreference readonlyPasteboard preference settings.
pdfExportPreferencesPDFExportPreference readonlyA collection of PDF export preferences.
pdfExportPresetsPDFExportPresets readonlyA collection of PDF export presets.
pdfPlacePreferencesPDFPlacePreference readonlyThe PDF place preference properties that define how PDF files are placed in the current document.
performanceMetricsArray of number readonlyThe available performance metrics.
placeableFileExtensionsArray of string readonlyLists the extensions of file types that can be placed.
placeableFileTypesArray of string readonlyLists the types of files that can be placed.
pngExportPreferencesPNGExportPreference readonlyPNG export preferences.
polygonPreferencesPolygonPreference readonlyPolygon preference properties to use to define default settings for creating a polygon.
preferencesPreferences readonlyA collection of preferences objects.
preflightBookOptionsPreflightBookOption readonlyPreflight book option settings.
preflightOptionsPreflightOption readonlyPreflight option settings.
preflightProcessesPreflightProcesses readonlyA collection of preflight processes.
preflightProfilesPreflightProfiles readonlyA collection of preflight profiles.
preflightRulesPreflightRules readonlyA collection of preflight rules.
printerPresetsPrinterPresets readonlyA collection of printer presets.
propertiesObject r/wA property that allows setting of several properties at the same time.
redoHistoryArray of string readonlyThe names of the items in the redo stack.
redoNamestring readonlyThe name of the action on the top of the redo stack.
scriptArgsScriptArg readonlyArguments to pass to a script.
scriptMenuActionsScriptMenuActions readonlyA collection of script menu actions.
scriptPreferencesScriptPreference readonlyScript preferences.
selectionArray of NothingEnum
Object
Object
r/wThe selected object(s). Can also accept: Object or NothingEnum enumerator.
selectionKeyObjectNothingEnum
PageItem
r/wThe key object of the selection. Can also accept: NothingEnum enumerator.
serialNumberstring readonlyThe user's serial number.
smartGuidePreferencesSmartGuidePreference readonlySmart Guide preference properties.
spellPreferencesSpellPreference readonlySpell-check preferences.
storyGridDataStoryGridDataInformation readonlyDefault properties specific to frame grids.
storyPreferencesStoryPreference readonlyStory preference settings.
storyWindowsStoryWindows readonlyA collection of story windows.
stripedStrokeStylesStripedStrokeStyles readonlyA collection of striped stroke styles.
strokeFillProxySettingsStrokeFillProxySetting readonlyStroke/fill proxy settings.
strokeStylesStrokeStyles readonlyA collection of stroke styles.
swatchesSwatches readonlyA collection of swatches.
swfExportPreferencesSWFExportPreference readonlySWF export preferences.
tableStyleGroupsTableStyleGroups readonlyA collection of table style groups.
tableStyleMappingsTableStyleMappings readonlyA collection of table style mappings.
tableStylesTableStyles readonlyA collection of table styles.
taggedPDFPreferencesTaggedPDFPreference readonlyTagged PDF preferences.
taggedTextExportPreferencesTaggedTextExportPreference readonlyTagged text export preferences.
taggedTextImportPreferencesTaggedTextImportPreference readonlyTagged text import preferences.
textDefaultsTextDefault readonlyText default settings.
textEditingPreferencesTextEditingPreference readonlyText editing preference settings.
textExportPreferencesTextExportPreference readonlyText export preferences.
textFramePreferencesTextFramePreference readonlyText frame preference settings.
textImportPreferencesTextImportPreference readonlyText import preferences.
textPreferencesTextPreference readonlyText preference settings.
textVariablesTextVariables readonlyA collection of text variables.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
tintsTints readonlyA collection of tints.
toolBoxToolsToolBox readonlyThe current tool box states
trackChangesPreferencesTrackChangesPreference readonlyTrack changes preference settings.
transformPreferencesTransformPreference readonlyTransform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing.
transformationMatricesTransformationMatrices readonlyA collection of transformation matrices.
transparencyPreferencesTransparencyPreference readonlyTransparency preference settings.
trapPresetsTrapPresets readonlyA collection of trap presets.
undoHistoryArray of string readonlyThe names of the items in the undo stack.
undoNamestring readonlyThe name of the action on the top of the undo stack.
unusedSwatchesArray of Swatch readonlyThe swatches that are not being used.
userColor3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
userDictionariesUserDictionaries readonlyA collection of user dictionaries.
userNamestring r/wThe user associated with the tracked changes and notes.
versionstring readonlyThe application version.
viewPreferencesViewPreference readonlyView preference settings.
visiblebool readonlyIf true, the Application is visible.
watermarkPreferencesWatermarkPreference readonlyWatermark preferences
windowsWindows readonlyA collection of windows.
wordRTFImportPreferencesWordRTFImportPreference readonlyWord and RTF import preferences.
xflExportPreferencesXFLExportPreference readonlyXFL export preferences.
xmlExportMapsXMLExportMaps readonlyA collection of XML export maps.
xmlExportPreferencesXMLExportPreference readonlyXML export preference settings.
xmlImportMapsXMLImportMaps readonlyA collection of XML import maps.
xmlImportPreferencesXMLImportPreference readonlyXML import preference settings.
xmlPreferencesXMLPreference readonlyThe XML preference settings.
xmlRuleProcessorsXMLRuleProcessors readonlyA collection of XML rule processors.
xmlTagsXMLTags readonlyA collection of XML tags.
xmlViewPreferencesXMLViewPreference readonlyXML view preference settings.

Class

PropertyTypeAccessDescription
AFTER_ACTIVATEstring readonlyDispatched after the Application becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_CLOSEstring readonlyDispatched after a Document is closed. This event bubbles. This event is not cancelable. (default: afterClose)
AFTER_CONTEXT_CHANGEDstring readonlyDispatched after the active context changes. This event bubbles. This event is not cancelable. (default: afterContextChanged)
AFTER_QUITstring readonlyDispatched when the Application is quitting. Since the quit has been committed, it can not be canceled. This event bubbles. This event is not cancelable. (default: afterQuit)
AFTER_SELECTION_ATTRIBUTE_CHANGEDstring readonlyDispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionAttributeChanged)
AFTER_SELECTION_CHANGEDstring readonlyDispatched after the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionChanged)
BEFORE_DEACTIVATEstring readonlyDispatched before the Application becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)
BEFORE_NEWstring readonlyDispatched before a Document is created. This event bubbles. This event is cancelable. (default: beforeNew)
BEFORE_OPENstring readonlyDispatched before a Document is opened. This event bubbles. This event is cancelable. (default: beforeOpen)
BEFORE_QUITstring readonlyDispatched before the Application is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable. (default: beforeQuit)

Methods

Instances

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

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

ParameterTypeDescription
namestringThe menu customization set. (Optional)

void applyShortcutSet ([name: string])
Applies the specified shortcut set file. No string will apply the default shortcut set.

ParameterTypeDescription
namestringThe shortcut set. (Optional)

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

ParameterTypeDescription
namestringThe workspace. (Optional)

void cancelAllTasks ()
Cancels all the background tasks.

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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

ParameterTypeDescription
reverseOrderboolIf 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.

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

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

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

void clearFrameFittingOptions ()
Removes the frame fittings options and resets it to the initial state.

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.

ParameterTypeDescription
queryNamestringThe query to delete.
searchModeSearchModes:
SearchModes.TEXT_SEARCH
SearchModes.GREP_SEARCH
SearchModes.GLYPH_SEARCH
SearchModes.OBJECT_SEARCH
The search mode.

void deleteUnusedTags ()
Deletes unused XML markup tags.

any doScript (script: varies[, language: ScriptLanguage=ScriptLanguage.UNKNOWN][, withArguments: Array of any][, undoMode: UndoModes=UndoModes.SCRIPT_REQUEST][, undoName: string=Script])
Executes the script in the specified language as a single transaction.

ParameterTypeDescription
scriptFile
JavaScript Function
String
The script to execute. Can accept: File, String or JavaScript Function.
languageScriptLanguage:
ScriptLanguage.UNKNOWN
ScriptLanguage.JAVASCRIPT
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)
withArgumentsArray of any An array of arguments passed to the script. (Optional)
undoModeUndoModes:
UndoModes.SCRIPT_REQUEST
UndoModes.ENTIRE_SCRIPT
UndoModes.AUTO_UNDO
UndoModes.FAST_ENTIRE_SCRIPT
How to undo this script. (Optional) (default: UndoModes.SCRIPT_REQUEST)
undoNamestringThe name of the undo step for entire script undo mode. (Optional) (default: Script)

void dumpBetweenMemoryMarks (from: Array of number, to: Array of number)
Dumps memory allocations from all marks in the specified range.

ParameterTypeDescription
fromArray of numberThe first mark in the range.
toArray of numberThe last mark in the range.

void dumpFromMemoryMark (from: Array of number)
Dumps memory allocations from the specified mark.

ParameterTypeDescription
fromArray of numberThe mark from which to dump memory.

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

ParameterTypeDescription
formatExportPresetFormat:
ExportPresetFormat.PDF_EXPORT_PRESETS_FORMAT
ExportPresetFormat.PRINTER_PRESETS_FORMAT
ExportPresetFormat.FLATTENER_PRESETS_FORMAT
ExportPresetFormat.DOCUMENT_PRESETS_FORMAT
The preset format.
toFileThe file to export to.
versionCommentsstringThe comments for this version. (Optional)
forceSaveboolForcibly save a version. (Optional) (default: false)

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

ParameterTypeDescription
toFileThe file to save to
strokeStyleListArray of StrokeStyleThe list of stroke styles to save
versionCommentsstringThe comment for this version (Optional)
forceSaveboolForcibly save a version (Optional) (default: false)

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

ParameterTypeDescription
keystringThe key.

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

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

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

ParameterTypeDescription
reverseOrderboolIf 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).

ParameterTypeDescription
forstringThe string to search for.

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

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

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

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

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

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

void generateIDMLSchema (to: File[, packageFormat: bool])
Generate schema for IDML.

ParameterTypeDescription
toFileThe folder path of the schema.
packageFormatboolIf true, generate schema for package format (multiple files). Default value is false. (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.

ParameterTypeDescription
namestringThe process color to load.

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

ParameterTypeDescription
namestringThe spot color to load.

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

ParameterTypeDescription
formatExportPresetFormat:
ExportPresetFormat.PDF_EXPORT_PRESETS_FORMAT
ExportPresetFormat.PRINTER_PRESETS_FORMAT
ExportPresetFormat.FLATTENER_PRESETS_FORMAT
ExportPresetFormat.DOCUMENT_PRESETS_FORMAT
The type of preset to import.
fromFileThe file to import presets from.

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

ParameterTypeDescription
formatImportFormat:
ImportFormat.CHARACTER_STYLES_FORMAT
ImportFormat.PARAGRAPH_STYLES_FORMAT
ImportFormat.TEXT_STYLES_FORMAT
ImportFormat.TOC_STYLES_FORMAT
ImportFormat.OBJECT_STYLES_FORMAT
ImportFormat.STROKE_STYLES_FORMAT
ImportFormat.TABLE_STYLES_FORMAT
ImportFormat.CELL_STYLES_FORMAT
ImportFormat.TABLE_AND_CELL_STYLES_FORMAT
The types of styles to import.
fromFileThe file containing the styles you want to import.
globalStrategyGlobalClashResolutionStrategy:
GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE
GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME
GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE
The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) (default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE)

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void loadConditions (from: File[, loadConditionSets: bool])
Load conditions from the specified file.

ParameterTypeDescription
fromFileThe path to the file that contains the conditions.
loadConditionSetsboolIf true, load the condition sets as well. (Optional)

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

ParameterTypeDescription
queryNamestringThe query to load.
searchModeSearchModes:
SearchModes.TEXT_SEARCH
SearchModes.GREP_SEARCH
SearchModes.GLYPH_SEARCH
SearchModes.OBJECT_SEARCH
The search mode.

MotionPreset loadMotionPreset (from: File)
Load motion preset from the specified file.

ParameterTypeDescription
fromFileThe Flash motion preset file.

PreflightProfile loadPreflightProfile (from: File)
Load preflight profile from the specified file.

ParameterTypeDescription
fromFileThe InDesign preflight profile file or InDesign document.

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

ParameterTypeDescription
fromFileThe swatch file or InDesign document.

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

ParameterTypeDescription
fromFileThe path to the file that contains the tags.

Array of any memoryStatistics ()
Gets the memory statistics from the server.

void mountProject (serverURL: string, projectName: string)
Mount a Version Cue project.

ParameterTypeDescription
serverURLstringThe URL of the Version Cue server containing the project
projectNamestringThe name of the Version Cue project to mount

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

ParameterTypeDescription
fromArray of Files
File
The file path(s) to the document, book, or library. Can accept: File or Array of Files.
showingWindowboolIf true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional) (default: true)
openOptionOpenOptions:
OpenOptions.DEFAULT_VALUE
OpenOptions.OPEN_ORIGINAL
OpenOptions.OPEN_COPY
How to open the document. (Optional) (default: OpenOptions.DEFAULT_VALUE)

void packageUCF (sourceFolder: File, ucfFile: File[, mimeMediaType: string=application/vnd.adobe.indesign-idml-package])
Package a folder into a UCF file.

ParameterTypeDescription
sourceFolderFileThe folder to be packaged into an IDML file. Does not validate structure of the folder pursuant to the IDML spec. Caller is responsible for making sure the files in the folder are correctly organized.
ucfFileFileThe destination UCF file. Will be overwritten if it already exists.
mimeMediaTypestringThe MIME media type, default value identifies package as IDML. (Optional) (default: application/vnd.adobe.indesign-idml-package)

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.

any performanceMetric (for: varies)
Gets the current value of the specified performance metric.

ParameterTypeDescription
forLong Integer
PerformanceMetricOptions
The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator.

string performanceMetricLongName (for: varies)
Gets the long name of the specified performance metric.

ParameterTypeDescription
forLong Integer
PerformanceMetricOptions
The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator.

string performanceMetricShortName (for: varies)
Gets the short name of the specified performance metric.

ParameterTypeDescription
forLong Integer
PerformanceMetricOptions
The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator.

void place (fileName: varies[, showingOptions: bool=false][, 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.

ParameterTypeDescription
fileNameArray of Files
File
One or more files to place. Can accept: File or Array of Files.
showingOptionsboolWhether to display the import options dialog (Optional) (default: false)
withPropertiesObjectInitial values for properties of the placed object(s) (Optional)

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

ParameterTypeDescription
fromArray of Files
File
One or more file paths. Can accept: File or Array of Files.
printDialogboolWhether to invoke the print dialog (Optional)
usingPrinterPreset
PrinterPresetTypes
Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

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

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

void redo ()
Redoes the last action.

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

ParameterTypeDescription
queryNamestringThe query to save.
searchModeSearchModes:
SearchModes.TEXT_SEARCH
SearchModes.GREP_SEARCH
SearchModes.GLYPH_SEARCH
SearchModes.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.

ParameterTypeDescription
toFileThe swatchbook file to save to.
swatchListArray of SwatchThe swatch(es) to save.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf 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.

ParameterTypeDescription
toFileThe full path to the file in which to save the tags.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

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

ParameterTypeDescription
selectableItemsArray of Objects
NothingEnum
Object
SelectAll
The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
SelectionOptions.SET_KEY
The selection status of the Application in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

void setApplicationPreferences (applicationPreferences: varies)
Sets the application's preferences.

ParameterTypeDescription
applicationPreferencesFile
LanguageAndRegion
The IDML defaults file or enumeration. Can accept: File or LanguageAndRegion enumerator.

void tileWindows ()
Tile all document windows

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

string toSpecifier ()
Retrieves the object specifier.

void togglePanelSystemVisibility ()
Toggles the visibility of the entire panel system.

string translateKeyString (for: string)
Translates a key string into localized form based on current application locale.

ParameterTypeDescription
forstringThe key string to translate

void undo ()
Undoes the last action.

void unpackageUCF (ucfFile: File, destinationFolder: File)
Unpackage a UCF file into a folder structure.

ParameterTypeDescription
ucfFileFileThe UCF file to be unpackaged.
destinationFolderFileThe folder where you would like the UCF file unpackaged to. Will be created if it does not exist.

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

Array of TaskState waitForAllTasks ()
Waits for all the background tasks to finish.

Element of

AlignDistributePreference.parent

AnchoredObjectDefault.parent

Application.parent

AutoCorrectPreference.parent

AutoCorrectTable.parent

BackgroundTask.parent

Book.parent

ButtonPreference.parent

CellStyle.parent

CellStyleGroup.parent

ChangeGlyphPreference.parent

ChangeGrepPreference.parent

ChangeObjectPreference.parent

ChangeTextPreference.parent

ChangeTransliteratePreference.parent

CharacterStyle.parent

CharacterStyleGroup.parent

CjkGridPreference.parent

ClipboardPreference.parent

Color.parent

ColorSetting.parent

CompositeFont.parent

Condition.parent

ConditionSet.parent

ConditionalTextPreference.parent

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

ExcelImportPreference.parent

ExportForWebPreference.parent

FindChangeGlyphOption.parent

FindChangeGrepOption.parent

FindChangeObjectOption.parent

FindChangeTextOption.parent

FindChangeTransliterateOption.parent

FindGlyphPreference.parent

FindGrepPreference.parent

FindObjectPreference.parent

FindTextPreference.parent

FindTransliteratePreference.parent

FlattenerPreset.parent

Font.parent

FontLockingPreference.parent

FootnoteOption.parent

FrameFittingOption.parent

GalleyPreference.parent

GeneralPreference.parent

GrabberPreference.parent

Gradient.parent

GridPreference.parent

GridPrintingPreference.parent

GuidePreference.parent

IMEPreference.parent

IdleTask.parent

ImageIOPreference.parent

ImagePreference.parent

ImportExportEvent.parent

ImportedPageAttribute.parent

IndexOptions.parent

IndexingSortOption.parent

Ink.parent

InteractivePDFExportPreference.parent

JPEGExportPreference.parent

KinsokuTable.parent

LanguageWithVendors.parent

LayoutAdjustmentPreference.parent

LayoutGridDataInformation.parent

Library.parent

LibraryPanel.parent

LinkingPreference.parent

Menu.parent

MenuAction.parent

MixedInk.parent

MixedInkGroup.parent

MojikumiTable.parent

MojikumiUiPreference.parent

MotionPreset.parent

NamedGrid.parent

NotePreference.parent

NumberingList.parent

ObjectStyle.parent

ObjectStyleGroup.parent

PDFExportPreference.parent

PDFExportPreset.parent

PDFPlacePreference.parent

PNGExportPreference.parent

PageItemDefault.parent

PagesPanel.parent

Panel.parent

ParagraphStyle.parent

ParagraphStyleGroup.parent

PasteboardPreference.parent

PolygonPreference.parent

PreflightBookOption.parent

PreflightOption.parent

PreflightProcess.parent

PreflightProfile.parent

PreflightRule.parent

PrinterPreset.parent

SWFExportPreference.parent

ScriptArg.parent

ScriptMenuAction.parent

ScriptPreference.parent

SmartGuidePreference.parent

SpellPreference.parent

StoryGridDataInformation.parent

StripedStrokeStyle.parent

StrokeFillProxySetting.parent

StrokeStyle.parent

Swatch.parent

TableStyle.parent

TableStyleGroup.parent

TaggedPDFPreference.parent

TaggedTextExportPreference.parent

TaggedTextImportPreference.parent

TextDefault.parent

TextEditingPreference.parent

TextExportPreference.parent

TextImportPreference.parent

TextPreference.parent

TextVariable.parent

Tint.parent

ToolBox.parent

TrackChangesPreference.parent

TransformPreference.parent

TransformationMatrix.parent

TransparencyPreference.parent

TrapPreset.parent

UserDictionary.parent

ViewPreference.parent

WatermarkPreference.parent

WordRTFImportPreference.parent

XFLExportPreference.parent

XMLExportMap.parent

XMLExportPreference.parent

XMLImportMap.parent

XMLImportPreference.parent

XMLPreference.parent

XMLRuleProcessor.parent

XMLTag.parent

XMLViewPreference.parent

Return

Array of Application Application.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index