Object

Application

The application.

Hierarchy

Application

68 objects

104 preference objects

Properties

Type	Access	Description
Book	read/write	The active book.
Document	read/write	The front-most document.
File	readonly	The current script running from the Scripts panel.
UndoModes	readonly	The undo mode for the current script execution.
LayoutWindow \| Window \| StoryWindow	read/write	The front-most window. Can return: Window, LayoutWindow or StoryWindow.
AlignDistributePreference	readonly	Preferences for alignment and distribution.
CellStyle[]	readonly	All Cell styles
CharacterStyle[]	readonly	Lists all character styles (regardless of their group).
ObjectStyle[]	readonly	All object styles contained by the Application.
ParagraphStyle[]	readonly	Lists all paragraph styles (regardless of their group).
String[]	readonly	The list of all object types (strings) a preflight rule can operate on.
String[]	readonly	The list of all categories that have been declared by rules.
String[]	readonly	The list of all known (declared) rule IDs.
TableStyle[]	readonly	All Table styles
AnchoredObjectDefault	readonly	Anchored object default settings.
AnchoredObjectSetting	readonly	Anchored object settings.
AutoCorrectPreference	readonly	Auto-correct preferences.
AutoCorrectTables<AutoCorrectTable>	readonly	A collection of auto-correct tables.
Boolean	read/write	If true, enables the auto detection of flex layout attributes when adding elements to flex container from canvas.
BackgroundTasks<BackgroundTask>	readonly	A collection of background task objects.
BaselineFrameGridOption	readonly	Baseline frame grid option settings.
Books<Book>	readonly	A collection of books.
ButtonPreference	readonly	Button preference settings.
CellStyleGroups<CellStyleGroup>	readonly	A collection of cell style groups.
CellStyleMappings<CellStyleMapping>	readonly	A collection of cell style mappings.
CellStyles<CellStyle>	readonly	A collection of cell styles.
ChangeColorPreference \| NothingEnum	read/write	Change color preferences. Can also accept: NothingEnum enumerator.
ChangeGlyphPreference \| NothingEnum	read/write	Change glyph preferences. Can also accept: NothingEnum enumerator.
ChangeGrepPreference \| NothingEnum	read/write	Change grep preferences. Can also accept: NothingEnum enumerator.
ChangeObjectPreference \| NothingEnum	read/write	Change object preferences. Can also accept: NothingEnum enumerator.
ChangeTextPreference \| NothingEnum	read/write	Change text preferences. Can also accept: NothingEnum enumerator.
ChangeTransliteratePreference \| NothingEnum	read/write	Change transliterate preferences. Can also accept: NothingEnum enumerator.
CharStyleMappings<CharStyleMapping>	readonly	A collection of char style mappings.
CharacterStyleGroups<CharacterStyleGroup>	readonly	A collection of character style groups.
CharacterStyles<CharacterStyle>	readonly	A collection of character styles.
CjkGridPreference	readonly	CJK grid preference settings.
Boolean	read/write	Clear overrides first before applying object style
ClipboardPreference	readonly	Clipboard preference properties that define the way that the application interacts with the system clipboard.
ColorGroups<ColorGroup>	readonly	A collection of color groups.
ColorSetting	readonly	Color setting properties that define color management defaults.
Colors<Color>	readonly	A collection of colors.
CompositeFonts<CompositeFont>	readonly	A collection of composite fonts.
ConditionSets<ConditionSet>	readonly	A collection of condition sets for conditional text.
ConditionalTextPreference	readonly	Conditional text preferences.
Conditions<Condition>	readonly	A collection of conditions for conditional text.
ContentPlacerObject	readonly	The Content Placer. Used to get a reference to the content placer object.
DashedStrokeStyles<DashedStrokeStyle>	readonly	A collection of dashed stroke styles.
DataMergeOption	readonly	The data merge option properties that define the data merge.
Dialogs<Dialog>	readonly	A collection of dialogs.
DictionaryPreference	readonly	User dictionary preference settings.
DisplayPerformancePreference	readonly	Display performance settings.
DisplaySettings<DisplaySetting>	readonly	Display setting properties.
DocumentPreference	readonly	Document preference settings.
DocumentPresets<DocumentPreset>	readonly	A collection of document presets.
Documents<Document>	readonly	A collection of documents.
DottedStrokeStyles<DottedStrokeStyle>	readonly	A collection of dotted stroke styles.
EndnoteOption	readonly	Endnote option settings.
EPSExportPreference	readonly	EPS export preferences.
EPSImportPreference	readonly	EPS import preferences.
EPubExportPreviewAppPreference	readonly	EPub export preview app preference settings.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
ExcelImportPreference	readonly	Excel import preferences.
ExportForWebPreference	readonly	The default export for web preferences.
FeatureSetOptions	readonly	The feature set.
File	readonly	The full path to the file.
FindChangeColorOption \| NothingEnum	read/write	Find/change color options. Can also accept: NothingEnum enumerator.
FindChangeGlyphOption \| NothingEnum	read/write	Find/change glyph options. Can also accept: NothingEnum enumerator.
FindChangeGrepOption \| NothingEnum	read/write	Find/change grep options. Can also accept: NothingEnum enumerator.
FindChangeObjectOption \| NothingEnum	read/write	Find/change object options. Can also accept: NothingEnum enumerator.
FindChangeTextOption \| NothingEnum	read/write	Find/change text options. Can also accept: NothingEnum enumerator.
FindChangeTransliterateOption \| NothingEnum	read/write	Find/change transliterate options. Can also accept: NothingEnum enumerator.
FindColorPreference \| NothingEnum	read/write	Find color preferences. Can also accept: NothingEnum enumerator.
FindGlyphPreference \| NothingEnum	read/write	Find glyph preferences. Can also accept: NothingEnum enumerator.
FindGrepPreference \| NothingEnum	read/write	Find grep preferences. Can also accept: NothingEnum enumerator.
FindObjectPreference \| NothingEnum	read/write	Find object preferences. Can also accept: NothingEnum enumerator.
FindTextPreference \| NothingEnum	read/write	Find text preferences. Can also accept: NothingEnum enumerator.
FindTransliteratePreference \| NothingEnum	read/write	Find transliterate preferences. Can also accept: NothingEnum enumerator.
FlattenerPresets<FlattenerPreset>	readonly	A collection of transparency flattener presets.
FontLockingPreference	readonly	Font locking preference settings.
FontSyncPreference	readonly	The font sync preference properties that define preferences for fonts.
Fonts<Font>	readonly	A collection of fonts.
FootnoteOption	readonly	Footnote option settings.
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.
File	readonly	The full path to the Application, including the name of the Application.
GalleyPreference	readonly	Galley preference settings.
GeneralPreference	readonly	General preference settings.
GpuPerformancePreference	readonly	GPU performance preferences.
GrabberPreference	readonly	Grabber preference properties that define display performance quality during scrolling.
Gradients<Gradient>	readonly	A collection of gradients.
GridPreference	readonly	Grid preference settings.
GridPrintingPreference	readonly	Grid printing preference and export settings.
GuidePreference	readonly	Guide preference settings.
Boolean	readonly	Get whether home screen is visible or not.
HttpLinkConnectionManagerObject	read/write	Experimental: Connection manager property
IdleTasks<IdleTask>	readonly	All attachable idle tasks.
ImageIOPreference	readonly	The image I/O preference properties that define preferences for importing images.
ImagePreference	readonly	Image preferences.
IMEPreference	readonly	IME preference settings.
ImportedPageAttribute	readonly	Placed InDesign page attributes.
InCopyExportOption	readonly	Export options for InCopy INCX document format.
IndexOptions	readonly	The index options properties that define how an index is formatted.
IndexingSortOptions<IndexingSortOption>	readonly	A collection of indexing sort options.
Inks<Ink>	readonly	A collection of inks.
InteractivePDFExportPreference	readonly	Interactive PDF export preferences.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
JPEGExportPreference	readonly	JPEG export preferences.
KinsokuTables<KinsokuTable>	readonly	A collection of kinsoku tables.
String	read/write	A property that can be set to any string.
LanguagesWithVendors<LanguageWithVendors>	readonly	A collection of languages with vendors.
LayoutGridDataInformation	readonly	Default properties specific to layout grids.
LayoutWindows<LayoutWindow>	readonly	A collection of layout windows.
Libraries<Library>	readonly	A collection of object libraries.
LinkedPageItemOption	readonly	Linked Page Item options
LinkedStoryOption	readonly	Linked story options
LinkingPreference	readonly	The links preference properties that define preferences for links.
LiveDrawingOptions	read/write	Delay before mouse operations trigger live screen drawing of page items.
Locale +12 more	readonly	The locale of the application.
MarginPreference	readonly	Margin preference settings.
MenuActions<MenuAction>	readonly	A collection of menu actions.
Menus<Menu>	readonly	A collection of menus.
MixedInkGroups<MixedInkGroup>	readonly	A collection of mixed ink groups.
MixedInks<MixedInk>	readonly	A collection of mixed inks.
Boolean	readonly	If true, a modal dialog or alert is active.
MojikumiTables<MojikumiTable>	readonly	A collection of mojikumi tables.
MojikumiUiPreference	readonly	Mojikumi user interface preference settings.
MotionPresets<MotionPreset>	readonly	A collection of Motion presets.
String	readonly	The name of the Application.
NamedGrids<NamedGrid>	readonly	A collection of named grids.
NotePreference	readonly	Note preference settings.
NumberingLists<NumberingList>	readonly	A collection of numbered lists.
ObjectStyleGroups<ObjectStyleGroup>	readonly	A collection of object style groups.
ObjectStyles<ObjectStyle>	readonly	A collection of object styles.
PageItemDefault	readonly	The default page item formatting for the Application.
Panels<Panel>	readonly	A collection of panels.
ParaStyleMappings<ParaStyleMapping>	readonly	A collection of para style mappings.
ParagraphStyleGroups<ParagraphStyleGroup>	readonly	A collection of paragraph style groups.
ParagraphStyles<ParagraphStyle>	readonly	A collection of paragraph styles.
Application	readonly	The parent of the Application (a Application).
PasteboardPreference	readonly	Pasteboard preference settings.
PDFExportPreference	readonly	A collection of PDF export preferences.
PDFExportPresets<PDFExportPreset>	readonly	A collection of PDF export presets.
PDFPlacePreference	readonly	The PDF place preference properties that define how PDF files are placed in the current document.
Number[]	readonly	The available performance metrics.
String[]	readonly	Lists the extensions of file types that can be placed.
String[]	readonly	Lists the types of files that can be placed.
PNGExportPreference	readonly	PNG export preferences.
PolygonPreference	readonly	Polygon preference properties to use to define default settings for creating a polygon.
Preferences<Preference>	readonly	A collection of preferences objects.
PreflightBookOption	readonly	Preflight book option settings.
PreflightOption	readonly	Preflight option settings.
PreflightProcesses<PreflightProcess>	readonly	A collection of preflight processes.
PreflightProfiles<PreflightProfile>	readonly	A collection of preflight profiles.
PreflightRules<PreflightRule>	readonly	A collection of preflight rules.
PrinterPresets<PrinterPreset>	readonly	A collection of printer presets.
Object	read/write	A property that allows setting of several properties at the same time.
String[]	readonly	The names of the items in the redo stack.
String	readonly	The name of the action on the top of the redo stack.
ScriptArg	readonly	Arguments to pass to a script.
ScriptMenuActions<ScriptMenuAction>	readonly	A collection of script menu actions.
ScriptPreference	readonly	Script preferences.
Object[] \| Object[] \| NothingEnum[]	read/write	The selected object(s). Can also accept: Object or NothingEnum enumerator.
PageItem \| NothingEnum	read/write	The key object of the selection. Can also accept: NothingEnum enumerator.
String	readonly	The user's serial number.
SmartGuidePreference	readonly	Smart Guide preference properties.
SpellPreference	readonly	Spell-check preferences.
StoryGridDataInformation	readonly	Default properties specific to frame grids.
StoryPreference	readonly	Story preference settings.
StoryWindows<StoryWindow>	readonly	A collection of story windows.
StripedStrokeStyles<StripedStrokeStyle>	readonly	A collection of striped stroke styles.
StrokeFillProxySetting	readonly	Stroke/fill proxy settings.
StrokeStyles<StrokeStyle>	readonly	A collection of stroke styles.
Swatches<Swatch>	readonly	A collection of swatches.
TableStyleGroups<TableStyleGroup>	readonly	A collection of table style groups.
TableStyleMappings<TableStyleMapping>	readonly	A collection of table style mappings.
TableStyles<TableStyle>	readonly	A collection of table styles.
TaggedPDFPreference	readonly	Tagged PDF preferences.
TaggedTextExportPreference	readonly	Tagged text export preferences.
TaggedTextImportPreference	readonly	Tagged text import preferences.
TextDefault	readonly	Text default settings.
TextEditingPreference	readonly	Text editing preference settings.
TextExportPreference	readonly	Text export preferences.
TextFramePreference	readonly	Text frame preference settings.
TextImportPreference	readonly	Text import preferences.
TextPreference	readonly	Text preference settings.
TextVariables<TextVariable>	readonly	A collection of text variables.
TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
Tints<Tint>	readonly	A collection of tints.
ToolBox	readonly	The current tool box states
TrackChangesPreference	readonly	Track changes preference settings.
TransformPreference	readonly	Transform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing.
TransformationMatrices<TransformationMatrix>	readonly	A collection of transformation matrices.
TransparencyPreference	readonly	Transparency preference settings.
TrapPresets<TrapPreset>	readonly	A collection of trap presets.
TypeContextualUiPreference	readonly	Preferences for showing contextual ui for alternates.
String[]	readonly	The names of the items in the undo stack.
String	readonly	The name of the action on the top of the undo stack.
Swatch[]	readonly	The swatches that are not being used.
String	readonly	The current user's adobe id
3 Reals (0 - 255)[] \| InCopyUIColors[] +53 more	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<UserDictionary>	readonly	A collection of user dictionaries.
String	readonly	The current user's GUID
String	read/write	The user associated with the tracked changes and notes.
String	readonly	The application version.
ViewPreference	readonly	View preference settings.
Boolean	readonly	If true, the Application is visible.
WatermarkPreference	readonly	Watermark preferences
Windows<Window>	readonly	A collection of windows.
WordRTFImportPreference	readonly	Word and RTF import preferences.
XMLExportMaps<XMLExportMap>	readonly	A collection of XML export maps.
XMLExportPreference	readonly	XML export preference settings.
XMLImportMaps<XMLImportMap>	readonly	A collection of XML import maps.
XMLImportPreference	readonly	XML import preference settings.
XMLPreference	readonly	The XML preference settings.
XMLRuleProcessors<XMLRuleProcessor>	readonly	A collection of XML rule processors.
XMLTags<XMLTag>	readonly	A collection of XML tags.
XMLViewPreference	readonly	XML view preference settings.

Events

Name	Description
	Dispatched after the Application becomes active. This event bubbles. This event is not cancelable.
	Dispatched after a Document is closed. This event bubbles. This event is not cancelable.
	Dispatched after the active context changes. This event bubbles. This event is not cancelable.
	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.
	Dispatched after a script method is invoked. This event bubbles. This event is not cancelable.
	Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable.
	Dispatched after the active selection changes. This event bubbles. This event is not cancelable.
	Dispatched before the Application becomes inactive. This event bubbles. This event is not cancelable.
	Dispatched before a Document is created. This event bubbles. This event is cancelable.
	Dispatched before a Document is opened. This event bubbles. This event is cancelable.
	Dispatched before the Application is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable.
	Dispatched before a script method is invoked. This event bubbles. This event is not cancelable.
	Dispatched after the Application changes. This event bubbles. This event is not cancelable.

Methods

→ void

Makes the application the front-most or active window.

→ EventListener

Adds an event listener.

eventType String The event type.

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

captures? Boolean This parameter is obsolete.

→ void

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.

name? String The menu customization set.

→ void

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

name? String The shortcut set.

→ void

Applies the specified workspace.

name? String The workspace.

→ void

Cancels all the background tasks.

→ void

Cascades all document windows.

→ Number

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

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ PageItem[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.

→ void

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

→ Number[]

Transforms color values

colorValue Number[] source color value

sourceColorSpace ColorSpace source color space

destinationColorSpace ColorSpace destination color space

→ void

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

→ void

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

destination File The location to write the file.

→ String

Creates a temporary copy of the file

from File The file to be copied

→ void

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

→ Boolean

Delete cloud document for a given reference.

assetReference String The reference to asset

→ void

Deletes the specified find/change query.

queryName String The query to delete.

searchMode SearchModes The search mode.

→ void

Deletes unused XML markup tags.

→ Varies

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

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

language? ScriptLanguage The language of the script to execute. If not specified, uses the language used to call this method.

withArguments? Varies[] An array of arguments passed to the script.

undoMode? UndoModes How to undo this script.

undoName? String The name of the undo step for entire script undo mode.

→ void

Dumps memory allocations from all marks in the specified range.

from Number[] The first mark in the range.

to Number[] The last mark in the range.

→ void

Dumps memory allocations from the specified mark.

from Number[] The mark from which to dump memory.

→ String

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.

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[] | String[] Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String.

miniFolioParams? Array[] | VariesType[] Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ String[]

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

destination File The location to write the file.

document Document The source InDesign document.

dpsArticleParams Array[] | VariesType[] Options for exporting a DPS article. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ void

Export the selected documents to a directory.

destination File The directory to write the folio.

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

folioMetadata Array[] | String[] Meta data for the folio. Can accept: Ordered array containing key:String, value:String.

exportFolioParams? Array[] | VariesType[] Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ void

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

destination File The location to write the package.

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

folioMetadata Array[] | String[] Meta data for the folio. Can accept: Ordered array containing key:String, value:String.

exportFolioParams? Array[] | VariesType[] Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ void

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

destination File The location to write the package.

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

folioMetadata Array[] | String[] Meta data for the folio. Can accept: Ordered array containing key:String, value:String.

exportFolioParams? Array[] | VariesType[] Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ String[]

Export the specified documents to a mini-folio.

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[] | String[] Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String.

miniFolioParams? Array[] | VariesType[] Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ void

Export the presets to a file.

format ExportPresetFormat The preset format.

to File The file to export to.

versionComments? String The comments for this version.

forceSave? Boolean Forcibly save a version.

→ Boolean

Exports selection as assets required for cloud library.

to File The path to the export file.

→ void

export the customised settings

fileReference String The reference to asset

→ void

Exports stroke styles or presets.

to File The file to save to

strokeStyleList StrokeStyle[] The list of stroke styles to save

versionComments? String The comment for this version

forceSave? Boolean Forcibly save a version

→ String

Gets the label value associated with the specified key.

key String The key.

→ Number

Finds color that matches the find what value.

→ Text[]

Finds glyphs that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ String[]

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

for String The string to search for.

→ PageItem[]

Finds objects that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ Text[]

Finds text that matches the find character type value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ void

Generate schema for IDML.

to File The folder path of the schema.

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

→ Varies[]

Get all overlays.

portraitDocumentForCheckingOverlays Document The portrait document for checking overlays.

landscapeDocumentForCheckingOverlays Document The landscape document for checking overlays.

miniFolioParams? Array[] | VariesType[] Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

→ String

Get a JSON string for the CCX Welcome dialog.

jsondata? String mode description

→ String

Internal Use Only.

→ String[]

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

digpubArticleVersion DigpubArticleVersion Version string(s) to retrieve.

→ String[]

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

digpubVersion DigpubVersion Version string(s) to retrieve.

→ Application[]

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

→ String

Internal Use Only.

→ Varies

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

charOrParaStyle? StyleType Style type to look at.

→ String[]

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

→ String[]

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

→ Number

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

→ Varies

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

→ void

Internal Use Only

resyncData String Internal Use Only

→ Color

Imports a process color swatch from a preloaded Adobe color book.

name String The process color to load.

→ Color

Imports a spot color swatch from an Adobe color book.

name String The spot color to load.

→ void

Imports presets from the specified file.

format ExportPresetFormat The type of preset to import.

from File The file to import presets from.

→ void

import the customised settings

fileReference String The reference to asset

→ void

Imports the specified styles.

format ImportFormat The types of styles to import.

from File The file containing the styles you want to import.

globalStrategy? GlobalClashResolutionStrategy The resolution strategy to employ for imported styles that have the same names as existing styles.

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

→ String

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

internalParameter1 String The first internal parameter

internalParameter2 String The second internal parameter

→ String

Invokes InDesign's Color Picker.

space ColorSpace Color space RGB, CMYK or LAB

colorValue Number[] Color values

→ Boolean

Whether the app is in touch mode or not.

→ Boolean

Whether user has opted-in to share usage data.

→ void

Load conditions from the specified file.

from File The path to the file that contains the conditions.

loadConditionSets? Boolean If true, load the condition sets as well.

→ void

Loads the specified find/change query.

queryName String The query to load.

searchMode SearchModes The search mode.

→ MotionPreset

Load motion preset from the specified file.

from File The Flash motion preset file.

→ PreflightProfile

Load preflight profile from the specified file.

from File The InDesign preflight profile file or InDesign document.

→ void

Load swatches from the specified file.

from File The swatch file or InDesign document.

→ void

Loads a set of XML markup tags from the specified file.

from File The path to the file that contains the tags.

→ Varies[]

Gets the memory statistics from the server.

→ void

Mount a Version Cue project.

serverURL String The URL of the Version Cue server containing the project

projectName String The name of the Version Cue project to mount

→ Varies

Opens the specified document, book, or library.

from File[] | 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.

openOption? OpenOptions How to open the document.

→ Boolean

Opens the cloud library asset for editing.

jsondata String JSON encoded information about the asset to be edited.

→ Document

Open cloud document for a given reference.

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.

→ void

Open the panel associated with the action.

id Number The ID.

→ void

Package a folder into a UCF file.

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.

→ void

Pastes data from the clipboard into the active document window.

→ void

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

→ void

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

→ void

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

→ Varies

Gets the current value of the specified performance metric.

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

→ String

Gets the long name of the specified performance metric.

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

→ String

Gets the short name of the specified performance metric.

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

→ void

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.

fileName File[] | Files[] One or more files to place. Can accept: File or Array of Files.

showingOptions? Boolean Whether to display the import options dialog

withProperties? Object Initial values for properties of the placed object(s)

→ void

Prints the specified file(s).

from File[] | Files[] One or more file paths. Can accept: File or Array of Files.

printDialog? Boolean Whether to invoke the print dialog

using? PrinterPresetTypes | PrinterPreset Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset.

→ void

Quits the application.

saving? SaveOptions The option to use for saving changes to open documents before quitting.

→ void

Redoes the last action.

→ Boolean

Removes the event listener.

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.

→ Boolean

Remove the file from most recently used files

to File The file to be removed

→ void

reset to default preferences

→ void

Saves the specified find/change query.

queryName String The query to save.

searchMode SearchModes The search mode.

→ void

Saves the specified swatch(es) to a swatchbook file.

to File The swatchbook file to save to.

swatchList Swatch[] The swatch(es) to save.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Saves a set of tags to an external file.

to File The full path to the file in which to save the tags.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Selects the specified object(s).

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

existingSelection? SelectionOptions The selection status of the Application in relation to previously selected objects.

→ void

Sets the application's preferences.

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

→ void

Set cloud libraries info.

librariesCollectionInfo String JSON encoded information about cloud libraries collection

→ void

Sets the export options for generation of a cloud asset.

maxwidth Number The maximum width of the thumbnail generated in pixels.

maxheight Number The maximum height of the thumbnail generated in pixels.

→ void

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

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

→ void

Tile all document windows

→ String

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

→ String

Retrieves the object specifier.

→ void

Toggles the visibility of the entire panel system.

→ String

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

for String The key string to translate

→ void

Undoes the last action.

→ void

Unpackage a UCF file into a folder structure.

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.

→ void

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

→ TaskState[]

Waits for all the background tasks to finish.

Object of 176

Properties elsewhere that hold a Application.

Parameter of 10

Method parameters that accept a Application.

CellStyle.move(reference)CellStyleGroup.move(reference)CharacterStyle.move(reference)CharacterStyleGroup.move(reference)ObjectStyle.move(reference)ObjectStyleGroup.move(reference)ParagraphStyle.move(reference)ParagraphStyleGroup.move(reference)TableStyle.move(reference)TableStyleGroup.move(reference)

Return 1

Methods that return a Application.

Application.getElements()