Application

The application.

Go to Property Listing | Method Listing

Methods:

activate, addEventListener, applyMenuCustomization, applyShortcutSet, applyWorkspace, cancelAllTasks, cascadeWindows, changeColor, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, clearFrameFittingOptions, colorTransform, copy, createCustomMiniFolio, createTemporaryCopy, cut, deleteCloudDocument, deleteFindChangeQuery, deleteUnusedTags, doScript, dumpBetweenMemoryMarks, dumpFromMemoryMark, exportArticleFolio, exportDpsArticle, exportFolioToDirectory, exportFolioToDirectoryPackage, exportFolioToPackage, exportMiniFolio, exportPresets, exportSelectionForCloudLibrary, exportStrokeStyles, extractLabel, findColor, findGlyph, findGrep, findKeyStrings, findObject, findText, findTransliterate, generateIDMLSchema, getAllOverlays, getCCXUserJSONData, getDigpubArticleVersion, getDigpubVersion, getElements, getStyleConflictResolutionStrategy, getSupportedArticleViewerVersions, getSupportedViewerVersions, getUntitledCount, getUserChoiceForCloudTextAddition, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importFile, importStyles, insertLabel, internalMethod, invokeColorPicker, isAppInTouchMode, isUserSharingAppUsageData, loadConditions, loadFindChangeQuery, loadMotionPreset, loadPreflightProfile, loadSwatches, loadXMLTags, memoryStatistics, mountProject, open, openCloudAssetForEdit, openCloudDocument, openPanel, packageUCF, paste, pasteInPlace, pasteInto, pasteWithoutFormatting, performanceMetric, performanceMetricLongName, performanceMetricShortName, place, print, quit, redo, removeEventListener, removeFileFromRecentFiles, saveFindChangeQuery, saveSwatches, saveXMLTags, select, setApplicationPreferences, setCloudLibraryCollection, setCloudLibraryOptions, setUntitledCount, tileWindows, toSource, toSpecifier, togglePanelSystemVisibility, translateKeyString, undo, unpackageUCF, updateFonts, waitForAllTasks

Objects:

AlignDistributePreference, AnchoredObjectDefault, AnchoredObjectSetting, AutoCorrectPreference, AutoCorrectTables, BackgroundTasks, BaselineFrameGridOption, Book, Books, Boolean, ButtonPreference, CellStyle, CellStyleGroups, CellStyleMappings, CellStyles, ChangeColorPreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, ChangeTransliteratePreference, CharStyleMappings, CharacterStyle, CharacterStyleGroups, CharacterStyles, CjkGridPreference, ClipboardPreference, ColorGroups, ColorSetting, Colors, CompositeFonts, ConditionSets, ConditionalTextPreference, Conditions, ContentPlacerObject, DashedStrokeStyles, DataMergeOption, Dialogs, DictionaryPreference, DisplayPerformancePreference, DisplaySettings, Document, DocumentPreference, DocumentPresets, Documents, DottedStrokeStyles, EPSExportPreference, EPSImportPreference, EPubExportPreviewAppPreference, EndnoteOption, EventListeners, Events, ExcelImportPreference, ExportForWebPreference, FeatureSetOptions, File, FindChangeColorOption, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindChangeTransliterateOption, FindColorPreference, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FindTransliteratePreference, FlattenerPresets, FontLockingPreference, FontSyncPreference, Fonts, FootnoteOption, FrameFittingOption, GalleyPreference, GeneralPreference, GpuPerformancePreference, GrabberPreference, Gradients, GridPreference, GridPrintingPreference, GuidePreference, HttpLinkConnectionManagerObject, IMEPreference, IdleTasks, ImageIOPreference, ImagePreference, ImportedPageAttribute, InCopyExportOption, InCopyUIColors, IndexOptions, IndexingSortOptions, Inks, InteractivePDFExportPreference, JPEGExportPreference, KinsokuTables, LanguagesWithVendors, LayoutGridDataInformation, LayoutWindow, LayoutWindows, Libraries, LinkedPageItemOption, LinkedStoryOption, LinkingPreference, LiveDrawingOptions, Locale, MarginPreference, MenuActions, Menus, MixedInkGroups, MixedInks, MojikumiTables, MojikumiUiPreference, MotionPresets, NamedGrids, NotePreference, NothingEnum, Number, NumberingLists, Object, ObjectStyle, ObjectStyleGroups, ObjectStyles, PDFExportPreference, PDFExportPresets, PDFPlacePreference, PNGExportPreference, PageItem, PageItemDefault, Panels, ParaStyleMappings, ParagraphStyle, ParagraphStyleGroups, ParagraphStyles, PasteboardPreference, PolygonPreference, Preferences, PreflightBookOption, PreflightOption, PreflightProcesses, PreflightProfiles, PreflightRules, PrinterPresets, ScriptArg, ScriptMenuActions, ScriptPreference, SmartGuidePreference, SpellPreference, StoryGridDataInformation, StoryPreference, StoryWindow, StoryWindows, String, StripedStrokeStyles, StrokeFillProxySetting, StrokeStyles, Swatch, Swatches, TableStyle, TableStyleGroups, TableStyleMappings, TableStyles, TaggedPDFPreference, TaggedTextExportPreference, TaggedTextImportPreference, TextDefault, TextEditingPreference, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextVariables, TextWrapPreference, Tints, ToolBox, TrackChangesPreference, TransformPreference, TransformationMatrices, TransparencyPreference, TrapPresets, TypeContextualUiPreference, UndoModes, UserDictionaries, ViewPreference, WatermarkPreference, Window, Windows, WordRTFImportPreference, XMLExportMaps, XMLExportPreference, XMLImportMaps, XMLImportPreference, XMLPreference, XMLRuleProcessors, XMLTags, XMLViewPreference

Preferences:

AlignDistributePreference, AutoCorrectPreference, BaselineFrameGridOption, ButtonPreference, ChangeColorPreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeObjectPreference, ChangeTextPreference, ChangeTransliteratePreference, CjkGridPreference, ClipboardPreference, ConditionalTextPreference, DataMergeOption, DictionaryPreference, DisplayPerformancePreference, DocumentPreference, EPSExportPreference, EPSImportPreference, EPubExportPreviewAppPreference, EndnoteOption, ExcelImportPreference, ExportForWebPreference, FindChangeColorOption, FindChangeGlyphOption, FindChangeGrepOption, FindChangeObjectOption, FindChangeTextOption, FindChangeTransliterateOption, FindColorPreference, FindGlyphPreference, FindGrepPreference, FindObjectPreference, FindTextPreference, FindTransliteratePreference, FontLockingPreference, FontSyncPreference, FootnoteOption, FrameFittingOption, GalleyPreference, GeneralPreference, GpuPerformancePreference, GrabberPreference, GridPreference, GridPrintingPreference, GuidePreference, IMEPreference, ImageIOPreference, ImagePreference, InCopyExportOption, IndexOptions, IndexingSortOptions, InteractivePDFExportPreference, JPEGExportPreference, LinkedPageItemOption, LinkedStoryOption, LinkingPreference, MarginPreference, MojikumiUiPreference, NotePreference, NothingEnum, PDFExportPreference, PDFPlacePreference, PNGExportPreference, PasteboardPreference, PolygonPreference, Preferences, PreflightBookOption, PreflightOption, ScriptPreference, SmartGuidePreference, SpellPreference, StoryPreference, TaggedPDFPreference, TaggedTextExportPreference, TaggedTextImportPreference, TextEditingPreference, TextExportPreference, TextFramePreference, TextImportPreference, TextPreference, TextWrapPreference, TrackChangesPreference, TransformPreference, TransparencyPreference, ViewPreference, WatermarkPreference, 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.

activeScriptUndoMode

UndoModes

UndoModes.AUTO_UNDO

UndoModes.ENTIRE_SCRIPT

UndoModes.FAST_ENTIRE_SCRIPT

UndoModes.SCRIPT_REQUEST

readonly

The undo mode for the current script execution.

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

allPreflightObjectTypes

Array of String

readonly

The list of all object types (strings) a preflight rule can operate on.

allPreflightRuleCategories

Array of String

readonly

The list of all categories that have been declared by rules.

allPreflightRuleIDs

Array of String

readonly

The list of all known (declared) rule IDs.

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.

backgroundTasks

BackgroundTasks BackgroundTask

readonly

A collection of background task objects.

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.

cellStyleMappings

CellStyleMappings CellStyleMapping

readonly

A collection of cell style mappings.

cellStyles

CellStyles CellStyle

readonly

A collection of cell styles.

changeColorPreferences

ChangeColorPreference

NothingEnum.NOTHING

read/write

Change color preferences. Can also accept: NothingEnum enumerator.

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.

changeTransliteratePreferences

ChangeTransliteratePreference

NothingEnum.NOTHING

read/write

Change transliterate preferences. Can also accept: NothingEnum enumerator.

charStyleMappings

CharStyleMappings CharStyleMapping

readonly

A collection of char style mappings.

characterStyleGroups

CharacterStyleGroups CharacterStyleGroup

readonly

A collection of character style groups.

characterStyles

CharacterStyles CharacterStyle

readonly

A collection of character styles.

cjkGridPreferences

CjkGridPreference

readonly

CJK grid preference settings.

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.

colorGroups

ColorGroups ColorGroup

readonly

A collection of color groups.

colorSettings

ColorSetting

readonly

Color setting properties that define color management defaults.

colors

Colors Color

readonly

A collection of colors.

compositeFonts

CompositeFonts CompositeFont

readonly

A collection of composite fonts.

conditionSets

ConditionSets ConditionSet

readonly

A collection of condition sets for conditional text.

conditionalTextPreferences

ConditionalTextPreference

readonly

Conditional text preferences.

conditions

Conditions Condition

readonly

A collection of conditions for conditional text.

contentPlacer

ContentPlacerObject

readonly

The Content Placer. Used to get a reference to the content placer object.

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.

endnoteOptions

EndnoteOption

readonly

Endnote option settings.

epsExportPreferences

EPSExportPreference

readonly

EPS export preferences.

epsImportPreferences

EPSImportPreference

readonly

EPS import preferences.

epubViewingAppsPreferences

EPubExportPreviewAppPreference

readonly

EPub export preview app preference settings.

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

FeatureSetOptions.ROMAN

readonly

The feature set.

filePath

File

readonly

The full path to the file.

findChangeColorOptions

FindChangeColorOption

NothingEnum.NOTHING

read/write

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

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.

findChangeTransliterateOptions

FindChangeTransliterateOption

NothingEnum.NOTHING

read/write

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

findColorPreferences

FindColorPreference

NothingEnum.NOTHING

read/write

Find color preferences. 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.

findTransliteratePreferences

FindTransliteratePreference

NothingEnum.NOTHING

read/write

Find transliterate preferences. Can also accept: NothingEnum enumerator.

flattenerPresets

FlattenerPresets FlattenerPreset

readonly

A collection of transparency flattener presets.

fontLockingPreferences

FontLockingPreference

readonly

Font locking preference settings.

fontSyncPreferences

FontSyncPreference

readonly

The font sync preference properties that define preferences for fonts.

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.

gpuPerformancePreferences

GpuPerformancePreference

readonly

GPU performance preferences.

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.

gridPrintingPreferences

GridPrintingPreference

readonly

Grid printing preference and export settings.

guidePreferences

GuidePreference

readonly

Guide preference settings.

homeScreenVisible

Boolean

readonly

Get whether home screen is visible or not.

httpLinkConnectionManager

HttpLinkConnectionManagerObject

read/write

Experimental: Connection manager property

idleTasks

IdleTasks IdleTask

readonly

All attachable idle tasks.

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.

interactivePDFExportPreferences

InteractivePDFExportPreference

readonly

Interactive PDF export preferences.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

jpegExportPreferences

JPEGExportPreference

readonly

JPEG export preferences.

kinsokuTables

KinsokuTables KinsokuTable

readonly

A collection of kinsoku tables.

label

String

read/write

A property that can be set to any string.

languagesWithVendors

LanguagesWithVendors

readonly

A collection of languages with vendors.

layoutGridData

LayoutGridDataInformation

readonly

Default properties specific to layout grids.

layoutWindows

LayoutWindows LayoutWindow

readonly

A collection of layout windows.

libraries

Libraries Library

readonly

A collection of object libraries.

linkedPageItemOptions

LinkedPageItemOption

readonly

Linked Page Item options

linkedStoryOptions

LinkedStoryOption

readonly

Linked story options

linkingPreferences

LinkingPreference

readonly

The links preference properties that define preferences for links.

liveScreenDrawing

LiveDrawingOptions

LiveDrawingOptions.DELAYED

LiveDrawingOptions.IMMEDIATELY

LiveDrawingOptions.NEVER

read/write

Delay before mouse operations trigger live screen drawing of page items.

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

Locale.POLISH_LOCALE

Locale.PORTUGUESE_LOCALE

Locale.ROMANIAN_LOCALE

Locale.RUSSIAN_LOCALE

Locale.SIMPLIFIED_CHINESE_LOCALE

Locale.SPANISH_LOCALE

Locale.SWEDISH_LOCALE

Locale.TRADITIONAL_CHINESE_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.

mojikumiTables

MojikumiTables MojikumiTable

readonly

A collection of mojikumi tables.

mojikumiUIPreferences

MojikumiUiPreference

readonly

Mojikumi user interface preference settings.

motionPresets

MotionPresets MotionPreset

readonly

A collection of Motion presets.

name

String

readonly

The name of the Application.

namedGrids

NamedGrids NamedGrid

readonly

A collection of named grids.

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.

paraStyleMappings

ParaStyleMappings ParaStyleMapping

readonly

A collection of para style mappings.

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.

performanceMetrics

Array of Number

readonly

The available performance metrics.

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.

pngExportPreferences

PNGExportPreference

readonly

PNG export preferences.

polygonPreferences

PolygonPreference

readonly

Polygon preference properties to use to define default settings for creating a polygon.

preferences

Preferences Preference

readonly

A collection of preferences objects.

preflightBookOptions

PreflightBookOption

readonly

Preflight book option settings.

preflightOptions

PreflightOption

readonly

Preflight option settings.

preflightProcesses

PreflightProcesses

readonly

A collection of preflight processes.

preflightProfiles

PreflightProfiles PreflightProfile

readonly

A collection of preflight profiles.

preflightRules

PreflightRules PreflightRule

readonly

A collection of preflight rules.

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.

selectionKeyObject

PageItem

NothingEnum.NOTHING

read/write

The key object of the selection. Can also accept: NothingEnum enumerator.

serialNumber

String

readonly

The user's serial number.

smartGuidePreferences

SmartGuidePreference

readonly

Smart Guide preference properties.

spellPreferences

SpellPreference

readonly

Spell-check preferences.

storyGridData

StoryGridDataInformation

readonly

Default properties specific to frame grids.

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.

strokeFillProxySettings

StrokeFillProxySetting

readonly

Stroke/fill proxy settings.

strokeStyles

StrokeStyles StrokeStyle

readonly

A collection of stroke styles.

swatches

Swatches

readonly

A collection of swatches.

tableStyleGroups

TableStyleGroups TableStyleGroup

readonly

A collection of table style groups.

tableStyleMappings

TableStyleMappings TableStyleMapping

readonly

A collection of table style mappings.

tableStyles

TableStyles TableStyle

readonly

A collection of table styles.

taggedPDFPreferences

TaggedPDFPreference

readonly

Tagged PDF preferences.

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.

textWrapPreferences

TextWrapPreference

readonly

The text wrap preference properties that define the default formatting for wrapping text around objects.

tints

Tints Tint

readonly

A collection of tints.

toolBoxTools

ToolBox

readonly

The current tool box states

trackChangesPreferences

TrackChangesPreference

readonly

Track changes preference settings.

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.

typeContextualUiPrefs

TypeContextualUiPreference

readonly

Preferences for showing contextual ui for alternates.

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.

userAdobeId

String

readonly

The current user's adobe id

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.

userGuid

String

readonly

The current user's GUID

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.

watermarkPreferences

WatermarkPreference

readonly

Watermark preferences

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.

Constants/Events

Name

Type

Access

Description

AFTER_ACTIVATE

String

readonly

Dispatched after the Application becomes active. This event bubbles. This event is not cancelable.

AFTER_CLOSE

String

readonly

Dispatched after a Document is closed. This event bubbles. This event is not cancelable.

AFTER_CONTEXT_CHANGED

String

readonly

Dispatched after the active context changes. This event bubbles. This event is not cancelable.

AFTER_QUIT

String

readonly

Dispatched when the Application is quitting. Since the quit has been committed, it can not be canceled. This event bubbles. This event is not cancelable.

AFTER_SELECTION_ATTRIBUTE_CHANGED

String

readonly

Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.

AFTER_SELECTION_CHANGED

String

readonly

Dispatched after the active selection changes. This event bubbles. This event is not cancelable.

BEFORE_DEACTIVATE

String

readonly

Dispatched before the Application becomes inactive. This event bubbles. This event is not cancelable.

BEFORE_NEW

String

readonly

Dispatched before a Document is created. This event bubbles. This event is cancelable.

BEFORE_OPEN

String

readonly

Dispatched before a Document is opened. This event bubbles. This event is cancelable.

BEFORE_QUIT

String

readonly

Dispatched before the Application is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable.

HOME_SCREEN_VISIBILITY_CHANGE

String

readonly

Dispatched after the Application changes. This event bubbles. This event is not cancelable.

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 applyShortcutSet (name:String)

Applies the specified shortcut set file. No string will apply the default shortcut set.

Parameter

Type

Description

name

String

The shortcut set. (Optional)

undefined applyWorkspace (name:String)

Applies the specified workspace.

Parameter

Type

Description

name

String

The workspace. (Optional)

undefined cancelAllTasks ()

Cancels all the background tasks.

undefined cascadeWindows ()

Cascades all document windows.

Number changeColor ()

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

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)

Text changeTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter

Type

Description

reverseOrder

Boolean

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

undefined clearFrameFittingOptions ()

Removes the frame fittings options and resets it to the initial state.

Number colorTransform (colorValue:Array of Number, sourceColorSpace:ColorSpace, destinationColorSpace:ColorSpace)

Transforms color values

Parameter

Type

Description

colorValue

Array of Number

source color value

sourceColorSpace

ColorSpace

ColorSpace.CMYK

ColorSpace.HSB

ColorSpace.LAB

ColorSpace.MIXEDINK

ColorSpace.RGB

source color space

destinationColorSpace

ColorSpace

ColorSpace.CMYK

ColorSpace.HSB

ColorSpace.LAB

ColorSpace.MIXEDINK

ColorSpace.RGB

destination color space

undefined copy ()

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

undefined createCustomMiniFolio (miniFolioDescription:Array of Varies File LongInteger LongLongInteger Orderedarraycontainingkey:String String Value:Boolean Any Types., destination:File)

Create a mini-folio out of asset and overlay descriptions. Schema for the mini folio description: || Key || Type || Required? || Description || | contentstackid | string | yes | The explicit ID to be used for this stack | | tocImage | file | no | The TOC image for the mini-folio | | narrowdimension | int | no | Targetted export size, measured along narrow dimension | | widedimension | int | no | Targetted export size, measured along wide dimension | | smoothscrolling | @enum(SmoothScrollingOptions) | no | The smooth scrolling behavior for this stack (default is noSmoothScroll) | | locationforgeneratedassets | file | no | If included, this is an existing directory where the generated assets should be created. | | overlays | array | no | see the SDK Overlay Builder APIs | | assets | array | yes | The assets for the mini - folio, described below. | | assetDependencies | array | no | Files that are needed by the asset, that will be included in the package but not the manifest. | | metadata | array | no | The metadata for the mini-folio described below. | | showprogressbar | boolean | no | Either true or false to indicate whether we should show a progress bar (default is false) | | targetviewerversion | string | no | If provided (in the form "major.minor.revision") a folio compatible with the viewer version is produced. If omitted, the latest folio format is produced. | CS5 | The following are fields in the array for "assets": || Key || Type || Required? || Description || | file | file | yes | The asset file | | type | string | yes | The asset file type, either "web" for HTML or "image" for a raster | | width | int | yes | The asset width | | height | int | yes | The asset height | | orientation | string | yes | The asset orientation, either "portrait" or "landscape" | | thumbnail | file | no | A thumbnail of the asset to be used in browse mode | | scrubber | file | no | A thumbnail of the asset to be used in scrubber mode | The following are fields in the array for "assetDependencies": || Key || Type || Required? || Description || | file | file | no | The dependent file | | relativePath | string | no | The relative path to the file, for use in the package | The following are fields in the array for "metadata": || Key || Type || Required? || Description || | any string | string or boolean | no | any key/value where the key is a string, and the value is either a string or a boolean, such as those described in "export folio meta data" |

Parameter

Type

Description

miniFolioDescription

Array of File

Array of LongInteger

Array of LongLongInteger

Array of Orderedarraycontainingkey:String

Array of String

Array of Value:Boolean

Array of Any Types.

A dictionary describing the custom mini folio to create. Can accept: Ordered array containing key:String, value:Boolean, Long Integer, Long Long Integer, String, File or Array of Any Types.

destination

File

The location to write the file.

String createTemporaryCopy (from:File)

Creates a temporary copy of the file

Parameter

Type

Description

from

File

The file to be copied

undefined cut ()

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

Boolean deleteCloudDocument (assetReference:String)

Delete cloud document for a given reference.

Parameter

Type

Description

assetReference

String

The reference to asset

undefined deleteFindChangeQuery (queryName:String, searchMode:SearchModes)

Deletes the specified find/change query.

Parameter

Type

Description

queryName

String

The query to delete.

searchMode

SearchModes

SearchModes.COLOR_SEARCH

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 JavaScriptFunction, [language:ScriptLanguage=ScriptLanguage], withArguments:Array of Varies, [undoMode:UndoModes=UndoModes], [undoName:String=String])

Executes the script in the specified language as a single transaction.

Parameter

Type

Description

script

File

String

JavaScriptFunction

The script to execute. Can accept: File, String or JavaScript Function.

language

ScriptLanguage

ScriptLanguage.UNKNOWN

ScriptLanguage.VISUAL_BASIC

ScriptLanguage.UXPSCRIPT

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)

withArguments

Array of Varies

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

undoMode

UndoModes

UndoModes.AUTO_UNDO

UndoModes.ENTIRE_SCRIPT

UndoModes.FAST_ENTIRE_SCRIPT

UndoModes.SCRIPT_REQUEST

How to undo this script. (Optional)

(default: UndoModes.SCRIPT_REQUEST)

undoName

String

The name of the undo step for entire script undo mode. (Optional)

(default: Skript)

undefined dumpBetweenMemoryMarks (from:Array of Number, to:Array of Number)

Dumps memory allocations from all marks in the specified range.

Parameter

Type

Description

from

Array of Number

The first mark in the range.

to

Array of Number

The last mark in the range.

undefined dumpFromMemoryMark (from:Array of Number)

Dumps memory allocations from the specified mark.

Parameter

Type

Description

from

Array of Number

The mark from which to dump memory.

String exportArticleFolio (destination:File, portraitDocument:Document, landscapeDocument:Document, folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, miniFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Export the specified documents to an article folio. Note: This method behaves identically to @method(exportMiniFolio), but differs in its return value. @method(exportMiniFolio) returns an array of warning strings whereas this method returns an XML structure.

Parameter

Type

Description

destination

File

The location to write the file.

portraitDocument

Document

The InDesign document for the stack's portrait orientation.

landscapeDocument

Document

The InDesign document for the stack's landscape orientation.

folioMetadata

Array of Orderedarraycontainingkey:String

Array of Value:String

Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional)

miniFolioParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

String exportDpsArticle (destination:File, document:Document, dpsArticleParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Export the specified document to a DPS article. Note: This method behaves similarly to @method(exportMiniFolio), but differs in its parameters.

Parameter

Type

Description

destination

File

The location to write the file.

document

Document

The source InDesign document.

dpsArticleParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Options for exporting a DPS article. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

undefined exportFolioToDirectory (destination:File, miniFolioList:Array of Varies File Files., folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, exportFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Export the selected documents to a directory.

Parameter

Type

Description

destination

File

The directory to write the folio.

miniFolioList

File

Array of Files.

The mini folio(es) to add to the folio. Can accept: File or Array of Files.

folioMetadata

Array of Orderedarraycontainingkey:String

Array of Value:String

Meta data for the folio. Can accept: Ordered array containing key:String, value:String.

exportFolioParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

undefined exportFolioToDirectoryPackage (destination:File, miniFolioList:Array of Varies File Files., folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, exportFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Export the selected documents to a compressed folio file that contains non-compressed mini folios.

Parameter

Type

Description

destination

File

The location to write the package.

miniFolioList

File

Array of Files.

The mini folio(es) to add to the folio. Can accept: File or Array of Files.

folioMetadata

Array of Orderedarraycontainingkey:String

Array of Value:String

Meta data for the folio. Can accept: Ordered array containing key:String, value:String.

exportFolioParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

undefined exportFolioToPackage (destination:File, miniFolioList:Array of Varies File Files., folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, exportFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Export the selected documents to a compressed folio file that contains compressed mini folios.

Parameter

Type

Description

destination

File

The location to write the package.

miniFolioList

File

Array of Files.

The mini folio(es) to add to the folio. Can accept: File or Array of Files.

folioMetadata

Array of Orderedarraycontainingkey:String

Array of Value:String

Meta data for the folio. Can accept: Ordered array containing key:String, value:String.

exportFolioParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

String exportMiniFolio (destination:File, portraitDocument:Document, landscapeDocument:Document, folioMetadata:Array of Varies Orderedarraycontainingkey:String Value:String, miniFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Export the specified documents to a mini-folio.

Parameter

Type

Description

destination

File

The location to write the file.

portraitDocument

Document

The InDesign document for the stack's portrait orientation.

landscapeDocument

Document

The InDesign document for the stack's landscape orientation.

folioMetadata

Array of Orderedarraycontainingkey:String

Array of Value:String

Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional)

miniFolioParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (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)

Boolean exportSelectionForCloudLibrary (to:File)

Exports selection as assets required for cloud library.

Parameter

Type

Description

to

File

The path to the export file.

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.

Number findColor ()

Finds color that matches the find what value.

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)

Text findTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value.

Parameter

Type

Description

reverseOrder

Boolean

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

undefined generateIDMLSchema (to:File, packageFormat:Boolean)

Generate schema for IDML.

Parameter

Type

Description

to

File

The folder path of the schema.

packageFormat

Boolean

If true, generate schema for package format (multiple files). Default value is false. (Optional)

Varies getAllOverlays (portraitDocumentForCheckingOverlays:Document, landscapeDocumentForCheckingOverlays:Document, miniFolioParams:Array of Varies OrderedarraycontainingdataField:String DataValue:VariesType)

Get all overlays.

Parameter

Type

Description

portraitDocumentForCheckingOverlays

Document

The portrait document for checking overlays.

landscapeDocumentForCheckingOverlays

Document

The landscape document for checking overlays.

miniFolioParams

Array of OrderedarraycontainingdataField:String

Array of DataValue:VariesType

Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

String getCCXUserJSONData (jsondata:String)

Get a JSON string for the CCX Welcome dialog.

Parameter

Type

Description

jsondata

String

mode description (Optional)

String getDigpubArticleVersion (digpubArticleVersion:DigpubArticleVersion)

Get the current digital publishing article version number for the given parameter.

Parameter

Type

Description

digpubArticleVersion

DigpubArticleVersion

DigpubArticleVersion.ALL

DigpubArticleVersion.ARTICLE

DigpubArticleVersion.PLUGIN

Version string(s) to retrieve.

String getDigpubVersion (digpubVersion:DigpubVersion)

Get the current digital publishing version number for the given parameter.

Parameter

Type

Description

digpubVersion

DigpubVersion

DigpubVersion.ALL

DigpubVersion.FOLIO

DigpubVersion.PLIST

DigpubVersion.PLUGIN

Version string(s) to retrieve.

Application getElements ()

Resolves the object specifier, creating an array of object references.

Varies getStyleConflictResolutionStrategy (charOrParaStyle:StyleType)

Get the resolution strategy for style conflict, false if the user cancels

Parameter

Type

Description

charOrParaStyle

StyleType

StyleType.CHARACTER_STYLE_TYPE

StyleType.PARAGRAPH_STYLE_TYPE

Style type to look at. (Optional)

String getSupportedArticleViewerVersions ()

Get the list of article viewer versions the digital publishing plugin supports.

String getSupportedViewerVersions ()

Get the list of viewer versions the digital publishing plugin supports.

Number getUntitledCount ()

Gets the count which will be used in the name of the next untitled document.

Varies getUserChoiceForCloudTextAddition ()

Gets the decision from the user to add the content of text frame or the complete story in case of threaded text frame.

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.

String internalMethod (internalParameter1:String, internalParameter2:String)

Internal use only: a black box method for use by InDesign Engineering team only.

Parameter

Type

Description

internalParameter1

String

The first internal parameter

internalParameter2

String

The second internal parameter

String invokeColorPicker (space:ColorSpace, colorValue:Array of Number)

Invokes InDesign's Color Picker.

Parameter

Type

Description

space

ColorSpace

ColorSpace.CMYK

ColorSpace.HSB

ColorSpace.LAB

ColorSpace.MIXEDINK

ColorSpace.RGB

Color space RGB, CMYK or LAB

colorValue

Array of Number

Color values

Boolean isAppInTouchMode ()

Whether the app is in touch mode or not.

Boolean isUserSharingAppUsageData ()

Whether user has opted-in to share usage data.

undefined loadConditions (from:File, loadConditionSets:Boolean)

Load conditions from the specified file.

Parameter

Type

Description

from

File

The path to the file that contains the conditions.

loadConditionSets

Boolean

If true, load the condition sets as well. (Optional)

undefined loadFindChangeQuery (queryName:String, searchMode:SearchModes)

Loads the specified find/change query.

Parameter

Type

Description

queryName

String

The query to load.

searchMode

SearchModes

SearchModes.COLOR_SEARCH

SearchModes.GLYPH_SEARCH

SearchModes.GREP_SEARCH

SearchModes.OBJECT_SEARCH

SearchModes.TEXT_SEARCH

The search mode.

MotionPreset loadMotionPreset (from:File)

Load motion preset from the specified file.

Parameter

Type

Description

from

File

The Flash motion preset file.

PreflightProfile loadPreflightProfile (from:File)

Load preflight profile from the specified file.

Parameter

Type

Description

from

File

The InDesign preflight profile file or InDesign document.

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 memoryStatistics ()

Gets the memory statistics from the server.

undefined mountProject (serverURL:String, projectName:String)

Mount a Version Cue project.

Parameter

Type

Description

serverURL

String

The URL of the Version Cue server containing the project

projectName

String

The name of the Version Cue project to mount

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

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)

openOption

OpenOptions

OpenOptions.DEFAULT_VALUE

OpenOptions.OPEN_COPY

OpenOptions.OPEN_ORIGINAL

How to open the document. (Optional)

(default: OpenOptions.DEFAULT_VALUE)

Boolean openCloudAssetForEdit (jsondata:String)

Opens the cloud library asset for editing.

Parameter

Type

Description

jsondata

String

JSON encoded information about the asset to be edited.

Document openCloudDocument (assetReference:String, [showingWindow:Boolean=Boolean])

Open cloud document for a given reference.

Parameter

Type

Description

assetReference

String

The reference to asset

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 openPanel (id:Number)

Open the panel associated with the action.

Parameter

Type

Description

id

Number

The ID.

undefined packageUCF (sourceFolder:File, ucfFile:File, [mimeMediaType:String=String])

Package a folder into a UCF file.

Parameter

Type

Description

sourceFolder

File

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

ucfFile

File

The destination UCF file. Will be overwritten if it already exists.

mimeMediaType

String

The MIME media type, default value identifies package as IDML. (Optional)

(default: application/vnd.adobe.indesign-idml-package)

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.

Varies performanceMetric (for:Varies LongInteger PerformanceMetricOptions)

Gets the current value of the specified performance metric.

Parameter

Type

Description

for

LongInteger

PerformanceMetricOptions

PerformanceMetricOptions.AGMXSHOWTIME

PerformanceMetricOptions.ATTACHABLE_EVENT_COUNT

PerformanceMetricOptions.ATTACHED_SCRIPTS_COUNT

PerformanceMetricOptions.BIB_ALLOCATIONS

PerformanceMetricOptions.BIB_ALLOCATIONS_PEAK

PerformanceMetricOptions.BIB_CACHE

PerformanceMetricOptions.BIB_CACHE_PEAK

PerformanceMetricOptions.CHANGE_MANAGER_UPDATE_CALL_COUNT

PerformanceMetricOptions.CHANGE_MANAGER_UPDATE_CALL_TIME

PerformanceMetricOptions.CORE_ALLOCATION_COUNT

PerformanceMetricOptions.CORE_MEMORY_SIZE

PerformanceMetricOptions.CPU_TIME

PerformanceMetricOptions.CURRENT_MEMORY_MARK

PerformanceMetricOptions.DATABASE_FILE_BYTES_READ

PerformanceMetricOptions.DATABASE_FILE_BYTES_WRITTEN

PerformanceMetricOptions.DATABASE_FILE_PAGE_READS

PerformanceMetricOptions.DATABASE_FILE_READ_TIME

PerformanceMetricOptions.DATABASE_FILE_WRITE_TIME

PerformanceMetricOptions.DATABASE_INSTANTIATE_COUNT

PerformanceMetricOptions.DATABASE_NEW_UID_COUNT

PerformanceMetricOptions.DISPATCH_EVENT_TIME

PerformanceMetricOptions.DRAW_MANAGER_DRAW_TIME

PerformanceMetricOptions.DRAW_MANAGER_NUMBER_OF_INTERRUPTS

PerformanceMetricOptions.DROP_SHADOW_FILE_READ_BYTES

PerformanceMetricOptions.DROP_SHADOW_FILE_READ_TIME

PerformanceMetricOptions.DROP_SHADOW_FILE_WRITE_BYTES

PerformanceMetricOptions.DROP_SHADOW_FILE_WRITE_TIME

PerformanceMetricOptions.DROP_SHADOW_MEMORY_READ_BYTES

PerformanceMetricOptions.DROP_SHADOW_MEMORY_READ_TIME

PerformanceMetricOptions.DROP_SHADOW_MEMORY_WRITE_BYTES

PerformanceMetricOptions.DROP_SHADOW_MEMORY_WRITE_TIME

PerformanceMetricOptions.GALLEY_COMPOSITION_COUNT

PerformanceMetricOptions.GALLEY_COMPOSITION_TIME

PerformanceMetricOptions.GDI_OBJECT_COUNT

PerformanceMetricOptions.HANDLE_COUNT

PerformanceMetricOptions.HEAP_ALLOCATIONS

PerformanceMetricOptions.HEAP_ALLOCATIONS_PEAK

PerformanceMetricOptions.IMAGE_CACHE_ALLOCATIONS

PerformanceMetricOptions.IMAGE_CACHE_ALLOCATIONS_PEAK

PerformanceMetricOptions.IMAGE_CACHE_FILE_BYTES_READ

PerformanceMetricOptions.IMAGE_CACHE_FILE_BYTES_WRITTEN

PerformanceMetricOptions.IMAGE_CACHE_FILE_READ_TIME

PerformanceMetricOptions.IMAGE_CACHE_FILE_WRITE_TIME

PerformanceMetricOptions.INSTANCE_CACHE_PURGE_COUNT

PerformanceMetricOptions.LAYOUT_COMPOSITION_COUNT

PerformanceMetricOptions.LAYOUT_COMPOSITION_TIME

PerformanceMetricOptions.MEMORY_PURGE_COUNT

PerformanceMetricOptions.MEMORY_PURGE_TIME

PerformanceMetricOptions.MINISAVE_COUNT

PerformanceMetricOptions.NEW_SNAPSHOT_TIME

PerformanceMetricOptions.NUMBER_OF_THREADS

PerformanceMetricOptions.OVERALL_SYSTEM_CPU

PerformanceMetricOptions.OVERALL_USER_CPU

PerformanceMetricOptions.PDF_ALLOCACTIONS

PerformanceMetricOptions.PDF_ALLOCACTIONS_PEAK

PerformanceMetricOptions.PROCESS_IO_BYTES_READ

PerformanceMetricOptions.PROCESS_IO_BYTES_WRITTEN

PerformanceMetricOptions.RESIDENT_MEMORY_SIZE

PerformanceMetricOptions.SNAPSHOT_COUNT

PerformanceMetricOptions.SNAPSHOT_READ_WRITE_BYTE_COUNT

PerformanceMetricOptions.SNAPSHOT_READ_WRITE_TIME

PerformanceMetricOptions.VIRTUAL_MEMORY_SIZE

PerformanceMetricOptions.VXFERALLOC

PerformanceMetricOptions.VXFERALLOCPEAK

PerformanceMetricOptions.VXFERBYTESREAD

PerformanceMetricOptions.VXFERBYTESWRITTEN

PerformanceMetricOptions.VXFERFILEBYTESREAD

PerformanceMetricOptions.VXFERFILEBYTESWRITTEN

PerformanceMetricOptions.VXFERREADTIME

PerformanceMetricOptions.VXFERWRITETIME

PerformanceMetricOptions.XMP_FILTER_TIME

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

String performanceMetricLongName (for:Varies LongInteger PerformanceMetricOptions)

Gets the long name of the specified performance metric.

Parameter

Type

Description

for

LongInteger

PerformanceMetricOptions

PerformanceMetricOptions.AGMXSHOWTIME

PerformanceMetricOptions.ATTACHABLE_EVENT_COUNT

PerformanceMetricOptions.ATTACHED_SCRIPTS_COUNT

PerformanceMetricOptions.BIB_ALLOCATIONS

PerformanceMetricOptions.BIB_ALLOCATIONS_PEAK

PerformanceMetricOptions.BIB_CACHE

PerformanceMetricOptions.BIB_CACHE_PEAK

PerformanceMetricOptions.CHANGE_MANAGER_UPDATE_CALL_COUNT

PerformanceMetricOptions.CHANGE_MANAGER_UPDATE_CALL_TIME

PerformanceMetricOptions.CORE_ALLOCATION_COUNT

PerformanceMetricOptions.CORE_MEMORY_SIZE

PerformanceMetricOptions.CPU_TIME

PerformanceMetricOptions.CURRENT_MEMORY_MARK

PerformanceMetricOptions.DATABASE_FILE_BYTES_READ

PerformanceMetricOptions.DATABASE_FILE_BYTES_WRITTEN

PerformanceMetricOptions.DATABASE_FILE_PAGE_READS

PerformanceMetricOptions.DATABASE_FILE_READ_TIME

PerformanceMetricOptions.DATABASE_FILE_WRITE_TIME

PerformanceMetricOptions.DATABASE_INSTANTIATE_COUNT

PerformanceMetricOptions.DATABASE_NEW_UID_COUNT

PerformanceMetricOptions.DISPATCH_EVENT_TIME

PerformanceMetricOptions.DRAW_MANAGER_DRAW_TIME

PerformanceMetricOptions.DRAW_MANAGER_NUMBER_OF_INTERRUPTS

PerformanceMetricOptions.DROP_SHADOW_FILE_READ_BYTES

PerformanceMetricOptions.DROP_SHADOW_FILE_READ_TIME

PerformanceMetricOptions.DROP_SHADOW_FILE_WRITE_BYTES

PerformanceMetricOptions.DROP_SHADOW_FILE_WRITE_TIME

PerformanceMetricOptions.DROP_SHADOW_MEMORY_READ_BYTES

PerformanceMetricOptions.DROP_SHADOW_MEMORY_READ_TIME

PerformanceMetricOptions.DROP_SHADOW_MEMORY_WRITE_BYTES

PerformanceMetricOptions.DROP_SHADOW_MEMORY_WRITE_TIME

PerformanceMetricOptions.GALLEY_COMPOSITION_COUNT

PerformanceMetricOptions.GALLEY_COMPOSITION_TIME

PerformanceMetricOptions.GDI_OBJECT_COUNT

PerformanceMetricOptions.HANDLE_COUNT

PerformanceMetricOptions.HEAP_ALLOCATIONS

PerformanceMetricOptions.HEAP_ALLOCATIONS_PEAK

PerformanceMetricOptions.IMAGE_CACHE_ALLOCATIONS

PerformanceMetricOptions.IMAGE_CACHE_ALLOCATIONS_PEAK

PerformanceMetricOptions.IMAGE_CACHE_FILE_BYTES_READ

PerformanceMetricOptions.IMAGE_CACHE_FILE_BYTES_WRITTEN

PerformanceMetricOptions.IMAGE_CACHE_FILE_READ_TIME

PerformanceMetricOptions.IMAGE_CACHE_FILE_WRITE_TIME

PerformanceMetricOptions.INSTANCE_CACHE_PURGE_COUNT

PerformanceMetricOptions.LAYOUT_COMPOSITION_COUNT

PerformanceMetricOptions.LAYOUT_COMPOSITION_TIME

PerformanceMetricOptions.MEMORY_PURGE_COUNT

PerformanceMetricOptions.MEMORY_PURGE_TIME

PerformanceMetricOptions.MINISAVE_COUNT

PerformanceMetricOptions.NEW_SNAPSHOT_TIME

PerformanceMetricOptions.NUMBER_OF_THREADS

PerformanceMetricOptions.OVERALL_SYSTEM_CPU

PerformanceMetricOptions.OVERALL_USER_CPU

PerformanceMetricOptions.PDF_ALLOCACTIONS

PerformanceMetricOptions.PDF_ALLOCACTIONS_PEAK

PerformanceMetricOptions.PROCESS_IO_BYTES_READ

PerformanceMetricOptions.PROCESS_IO_BYTES_WRITTEN

PerformanceMetricOptions.RESIDENT_MEMORY_SIZE

PerformanceMetricOptions.SNAPSHOT_COUNT

PerformanceMetricOptions.SNAPSHOT_READ_WRITE_BYTE_COUNT

PerformanceMetricOptions.SNAPSHOT_READ_WRITE_TIME

PerformanceMetricOptions.VIRTUAL_MEMORY_SIZE

PerformanceMetricOptions.VXFERALLOC

PerformanceMetricOptions.VXFERALLOCPEAK

PerformanceMetricOptions.VXFERBYTESREAD

PerformanceMetricOptions.VXFERBYTESWRITTEN

PerformanceMetricOptions.VXFERFILEBYTESREAD

PerformanceMetricOptions.VXFERFILEBYTESWRITTEN

PerformanceMetricOptions.VXFERREADTIME

PerformanceMetricOptions.VXFERWRITETIME

PerformanceMetricOptions.XMP_FILTER_TIME

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

String performanceMetricShortName (for:Varies LongInteger PerformanceMetricOptions)

Gets the short name of the specified performance metric.

Parameter

Type

Description

for

LongInteger

PerformanceMetricOptions

PerformanceMetricOptions.AGMXSHOWTIME

PerformanceMetricOptions.ATTACHABLE_EVENT_COUNT

PerformanceMetricOptions.ATTACHED_SCRIPTS_COUNT

PerformanceMetricOptions.BIB_ALLOCATIONS

PerformanceMetricOptions.BIB_ALLOCATIONS_PEAK

PerformanceMetricOptions.BIB_CACHE

PerformanceMetricOptions.BIB_CACHE_PEAK

PerformanceMetricOptions.CHANGE_MANAGER_UPDATE_CALL_COUNT

PerformanceMetricOptions.CHANGE_MANAGER_UPDATE_CALL_TIME

PerformanceMetricOptions.CORE_ALLOCATION_COUNT

PerformanceMetricOptions.CORE_MEMORY_SIZE

PerformanceMetricOptions.CPU_TIME

PerformanceMetricOptions.CURRENT_MEMORY_MARK

PerformanceMetricOptions.DATABASE_FILE_BYTES_READ

PerformanceMetricOptions.DATABASE_FILE_BYTES_WRITTEN

PerformanceMetricOptions.DATABASE_FILE_PAGE_READS

PerformanceMetricOptions.DATABASE_FILE_READ_TIME

PerformanceMetricOptions.DATABASE_FILE_WRITE_TIME

PerformanceMetricOptions.DATABASE_INSTANTIATE_COUNT

PerformanceMetricOptions.DATABASE_NEW_UID_COUNT

PerformanceMetricOptions.DISPATCH_EVENT_TIME

PerformanceMetricOptions.DRAW_MANAGER_DRAW_TIME

PerformanceMetricOptions.DRAW_MANAGER_NUMBER_OF_INTERRUPTS

PerformanceMetricOptions.DROP_SHADOW_FILE_READ_BYTES

PerformanceMetricOptions.DROP_SHADOW_FILE_READ_TIME

PerformanceMetricOptions.DROP_SHADOW_FILE_WRITE_BYTES

PerformanceMetricOptions.DROP_SHADOW_FILE_WRITE_TIME

PerformanceMetricOptions.DROP_SHADOW_MEMORY_READ_BYTES

PerformanceMetricOptions.DROP_SHADOW_MEMORY_READ_TIME

PerformanceMetricOptions.DROP_SHADOW_MEMORY_WRITE_BYTES

PerformanceMetricOptions.DROP_SHADOW_MEMORY_WRITE_TIME

PerformanceMetricOptions.GALLEY_COMPOSITION_COUNT

PerformanceMetricOptions.GALLEY_COMPOSITION_TIME

PerformanceMetricOptions.GDI_OBJECT_COUNT

PerformanceMetricOptions.HANDLE_COUNT

PerformanceMetricOptions.HEAP_ALLOCATIONS

PerformanceMetricOptions.HEAP_ALLOCATIONS_PEAK

PerformanceMetricOptions.IMAGE_CACHE_ALLOCATIONS

PerformanceMetricOptions.IMAGE_CACHE_ALLOCATIONS_PEAK

PerformanceMetricOptions.IMAGE_CACHE_FILE_BYTES_READ

PerformanceMetricOptions.IMAGE_CACHE_FILE_BYTES_WRITTEN

PerformanceMetricOptions.IMAGE_CACHE_FILE_READ_TIME

PerformanceMetricOptions.IMAGE_CACHE_FILE_WRITE_TIME

PerformanceMetricOptions.INSTANCE_CACHE_PURGE_COUNT

PerformanceMetricOptions.LAYOUT_COMPOSITION_COUNT

PerformanceMetricOptions.LAYOUT_COMPOSITION_TIME

PerformanceMetricOptions.MEMORY_PURGE_COUNT

PerformanceMetricOptions.MEMORY_PURGE_TIME

PerformanceMetricOptions.MINISAVE_COUNT

PerformanceMetricOptions.NEW_SNAPSHOT_TIME

PerformanceMetricOptions.NUMBER_OF_THREADS

PerformanceMetricOptions.OVERALL_SYSTEM_CPU

PerformanceMetricOptions.OVERALL_USER_CPU

PerformanceMetricOptions.PDF_ALLOCACTIONS

PerformanceMetricOptions.PDF_ALLOCACTIONS_PEAK

PerformanceMetricOptions.PROCESS_IO_BYTES_READ

PerformanceMetricOptions.PROCESS_IO_BYTES_WRITTEN

PerformanceMetricOptions.RESIDENT_MEMORY_SIZE

PerformanceMetricOptions.SNAPSHOT_COUNT

PerformanceMetricOptions.SNAPSHOT_READ_WRITE_BYTE_COUNT

PerformanceMetricOptions.SNAPSHOT_READ_WRITE_TIME

PerformanceMetricOptions.VIRTUAL_MEMORY_SIZE

PerformanceMetricOptions.VXFERALLOC

PerformanceMetricOptions.VXFERALLOCPEAK

PerformanceMetricOptions.VXFERBYTESREAD

PerformanceMetricOptions.VXFERBYTESWRITTEN

PerformanceMetricOptions.VXFERFILEBYTESREAD

PerformanceMetricOptions.VXFERFILEBYTESWRITTEN

PerformanceMetricOptions.VXFERREADTIME

PerformanceMetricOptions.VXFERWRITETIME

PerformanceMetricOptions.XMP_FILTER_TIME

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

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)

Boolean removeFileFromRecentFiles (to:File)

Remove the file from most recently used files

Parameter

Type

Description

to

File

The file to be removed

undefined saveFindChangeQuery (queryName:String, searchMode:SearchModes)

Saves the specified find/change query.

Parameter

Type

Description

queryName

String

The query to save.

searchMode

SearchModes

SearchModes.COLOR_SEARCH

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

SelectionOptions.SET_KEY

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

(default: SelectionOptions.REPLACE_WITH)

undefined setApplicationPreferences (applicationPreferences:Varies File LanguageAndRegion)

Sets the application's preferences.

Parameter

Type

Description

applicationPreferences

File

LanguageAndRegion

LanguageAndRegion.ALBANIA_ALBANIAN

LanguageAndRegion.BELARUS_BELARUSIAN

LanguageAndRegion.BRAZIL_PORTUGUESE

LanguageAndRegion.BULGARIA_BULGARIAN

LanguageAndRegion.CROATIA_CROATIAN

LanguageAndRegion.CZECH_REPUBLIC_CZECH

LanguageAndRegion.DENMARK_DANISH

LanguageAndRegion.ESTONIA_ESTONIAN

LanguageAndRegion.FINLAND_FINNISH

LanguageAndRegion.FRANCE_FRENCH

LanguageAndRegion.GERMANY_GERMAN

LanguageAndRegion.GREECE_GREEK

LanguageAndRegion.HUNGARY_HUNGARIAN

LanguageAndRegion.INDIA_TAMIL

LanguageAndRegion.INDIC

LanguageAndRegion.ISRAEL_HEBREW

LanguageAndRegion.ITALY_ITALIAN

LanguageAndRegion.JAPAN_JAPANESE

LanguageAndRegion.LATVIA_LATVIAN

LanguageAndRegion.LITUANIA_LITHUANIAN

LanguageAndRegion.NETHERLANDS_DUTCH

LanguageAndRegion.NORWAY_NORWEGIAN

LanguageAndRegion.POLAND_POLISH

LanguageAndRegion.REPUBLIC_OF_KOREA_KOREAN

LanguageAndRegion.ROMANIA_ROMANIAN

LanguageAndRegion.RUSSIAN_FEDERATION_RUSSIAN

LanguageAndRegion.SIMPLIFIED_CHINESE

LanguageAndRegion.SLOVAKIA_SLOVAK

LanguageAndRegion.SLOVENIA_SLOVENIAN

LanguageAndRegion.SPAIN_SPANISH

LanguageAndRegion.STANDARD_ARABIC

LanguageAndRegion.SWEDEN_SWEDISH

LanguageAndRegion.THAILAND_THAI

LanguageAndRegion.TRADITIONAL_CHINESE

LanguageAndRegion.TURKEY_TURKISH

LanguageAndRegion.UKRAINE_UKRAINIAN

LanguageAndRegion.UNITED_KINGDOM_ENGLISH

LanguageAndRegion.UNITED_STATES_ENGLISH

LanguageAndRegion.VIETNAM_VIETNAMESE

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

undefined setCloudLibraryCollection (librariesCollectionInfo:String)

Set cloud libraries info.

Parameter

Type

Description

librariesCollectionInfo

String

JSON encoded information about cloud libraries collection

undefined setCloudLibraryOptions (maxwidth:Number, maxheight:Number)

Sets the export options for generation of a cloud asset.

Parameter

Type

Description

maxwidth

Number

The maximum width of the thumbnail generated in pixels.

maxheight

Number

The maximum height of the thumbnail generated in pixels.

undefined setUntitledCount (untitledCount:Number)

Sets the count which will be used in the name of the next untitled document.

Parameter

Type

Description

untitledCount

Number

The count to be used in the name of the next untitled document. Only positive values are expected

undefined tileWindows ()

Tile all document windows

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

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

Parameter

Type

Description

for

String

The key string to translate

undefined undo ()

Undoes the last action.

undefined unpackageUCF (ucfFile:File, destinationFolder:File)

Unpackage a UCF file into a folder structure.

Parameter

Type

Description

ucfFile

File

The UCF file to be unpackaged.

destinationFolder

File

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

undefined updateFonts ()

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

TaskState waitForAllTasks ()

Waits for all the background tasks to finish.

Object of

global.app

AlignDistributePreference.parent

AnchoredObjectDefault.parent

AnchoredObjectSetting.parent

Application.parent

AutoCorrectPreference.parent

AutoCorrectTable.parent

BackgroundTask.parent

BaselineFrameGridOption.parent

Book.parent

ButtonPreference.parent

CellStyle.parent

CellStyleGroup.parent

CellStyleMapping.parent

ChangeColorPreference.parent

ChangeGlyphPreference.parent

ChangeGrepPreference.parent

ChangeObjectPreference.parent

ChangeTextPreference.parent

ChangeTransliteratePreference.parent

CharStyleMapping.parent

CharacterStyle.parent

CharacterStyleGroup.parent

CjkGridPreference.parent

ClipboardPreference.parent

Color.parent

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

EPubExportPreviewAppPreference.parent

EndnoteOption.parent

Event.parent

EventListener.parent

ExcelImportPreference.parent

ExportForWebPreference.parent

FindChangeColorOption.parent

FindChangeGlyphOption.parent

FindChangeGrepOption.parent

FindChangeObjectOption.parent

FindChangeTextOption.parent

FindChangeTransliterateOption.parent

FindColorPreference.parent

FindGlyphPreference.parent

FindGrepPreference.parent

FindObjectPreference.parent

FindTextPreference.parent

FindTransliteratePreference.parent

FlattenerPreset.parent

Font.parent

FontLockingPreference.parent

FontSyncPreference.parent

FootnoteOption.parent

FrameFittingOption.parent

GalleyPreference.parent

GeneralPreference.parent

GpuPerformancePreference.parent

GrabberPreference.parent

Gradient.parent

GridPreference.parent

GridPrintingPreference.parent

GuidePreference.parent

HttpLinkConnectionManagerObject.parent

IMEPreference.parent

IdleTask.parent

ImageIOPreference.parent

ImagePreference.parent

ImportExportEvent.parent

ImportedPageAttribute.parent

InCopyExportOption.parent

IndexOptions.parent

IndexingSortOption.parent

Ink.parent

InteractivePDFExportPreference.parent

JPEGExportPreference.parent

KinsokuTable.parent

LanguageWithVendors.parent

LayoutGridDataInformation.parent

Library.parent

LibraryPanel.parent

LinkedPageItemOption.parent

LinkedStoryOption.parent

LinkingPreference.parent

MarginPreference.parent

Menu.parent

MenuAction.parent

MixedInk.parent

MixedInkGroup.parent

MojikumiTable.parent

MojikumiUiPreference.parent

MotionPreset.parent

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

ParaStyleMapping.parent

ParagraphStyle.parent

ParagraphStyleGroup.parent

PasteboardPreference.parent

PolygonPreference.parent

Preference.parent

PreflightBookOption.parent

PreflightOption.parent

PreflightProcess.parent

PreflightProfile.parent

PreflightRule.parent

PrinterPreset.parent

ScriptArg.parent

ScriptMenuAction.parent

ScriptPreference.parent

SmartGuidePreference.parent

SpellPreference.parent

StoryGridDataInformation.parent

StoryPreference.parent

StripedStrokeStyle.parent

StrokeFillProxySetting.parent

StrokeStyle.parent

Swatch.parent

TableStyle.parent

TableStyleGroup.parent

TableStyleMapping.parent

TaggedPDFPreference.parent

TaggedTextExportPreference.parent

TaggedTextImportPreference.parent

TextDefault.parent

TextEditingPreference.parent

TextExportPreference.parent

TextFramePreference.parent

TextImportPreference.parent

TextPreference.parent

TextVariable.parent

TextWrapPreference.parent

Tint.parent

ToolBox.parent

TrackChangesPreference.parent

TransformPreference.parent

TransformationMatrix.parent

TransparencyPreference.parent

TrapPreset.parent

TypeContextualUiPreference.parent

UserDictionary.parent

ViewPreference.parent

WatermarkPreference.parent

WordRTFImportPreference.parent

XMLExportMap.parent

XMLExportPreference.parent

XMLImportMap.parent

XMLImportPreference.parent

XMLPreference.parent

XMLRuleProcessor.parent

XMLTag.parent

XMLViewPreference.parent

Return

Application.getElements()