BasicsApplication

Static Properties

Instance Properties

Methods

activate(

)

Makes the application the front-most or active window.

addEventListener(

eventType, handler ​[, captures=false])

→ EventListener

Adds an event listener.

eventType	string The event type.
handler	The event handler. Can accept: File or JavaScript Function.
captures	bool This parameter is obsolete. (Optional)

applyMenuCustomization(

[name])

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

applyShortcutSet(

[name])

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

name	string The shortcut set. (Optional)

applyWorkspace(

[name])

Applies the specified workspace.

name	string The workspace. (Optional)

cancelAllTasks(

)

Cancels all the background tasks.

cascadeWindows(

)

Cascades all document windows.

changeGlyph(

[reverseOrder])

→ Text

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

reverseOrder

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

changeGrep(

[reverseOrder])

→ Text

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

reverseOrder

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

changeObject(

[reverseOrder])

→ PageItem

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

reverseOrder

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

changeText(

[reverseOrder])

→ Text

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

reverseOrder

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

changeTransliterate(

[reverseOrder])

→ Text

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

reverseOrder

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

clearFrameFittingOptions(

)

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

colorTransform(

colorValue, sourceColorSpace, destinationColorSpace)

→ number

Transforms color values

colorValue	Array<number> source color value
sourceColorSpace	ColorSpace source color space
destinationColorSpace	ColorSpace destination color space

copy(

)

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

createCustomMiniFolio(

miniFolioDescription, destination)

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

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

createTemporaryCopy(

from)

→ string

Creates a temporary copy of the file

from	File The file to be copied

cut(

)

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

deleteFindChangeQuery(

queryName, searchMode)

Deletes the specified find/change query.

queryName	string The query to delete.
searchMode	SearchModes The search mode.

deleteUnusedTags(

)

Deletes unused XML markup tags.

doScript(

script ​[, language=ScriptLanguage.UNKNOWN], withArguments ​[, undoMode=UndoModes.SCRIPT_REQUEST] ​[, undoName="Script"])

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

script	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. (Optional)
withArguments	An array of arguments passed to the script. (Optional)
undoMode	UndoModes How to undo this script. (Optional)
undoName	string The name of the undo step for entire script undo mode. (Optional)

dumpBetweenMemoryMarks(

from, to)

Dumps memory allocations from all marks in the specified range.

from	Array<number> The first mark in the range.
to	Array<number> The last mark in the range.

dumpFromMemoryMark(

from)

Dumps memory allocations from the specified mark.

from	Array<number> The mark from which to dump memory.

exportArticleFolio(

destination, portraitDocument, landscapeDocument, folioMetadata, miniFolioParams)

→ 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	Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional)
miniFolioParams	Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

exportDpsArticle(

destination, document, dpsArticleParams)

→ 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	Options for exporting a DPS article. Can accept: Ordered array containing dataField:String, dataValue:Any Type.

exportFolioToDirectory(

destination, miniFolioList, folioMetadata, exportFolioParams)

Export the selected documents to a directory.

destination	File The directory to write the folio.
miniFolioList	The mini folio(es) to add to the folio. Can accept: File or Array of Files.
folioMetadata	Meta data for the folio. Can accept: Ordered array containing key:String, value:String.
exportFolioParams	Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

exportFolioToDirectoryPackage(

destination, miniFolioList, folioMetadata, exportFolioParams)

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

destination	File The location to write the package.
miniFolioList	The mini folio(es) to add to the folio. Can accept: File or Array of Files.
folioMetadata	Meta data for the folio. Can accept: Ordered array containing key:String, value:String.
exportFolioParams	Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

exportFolioToPackage(

destination, miniFolioList, folioMetadata, exportFolioParams)

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

destination	File The location to write the package.
miniFolioList	The mini folio(es) to add to the folio. Can accept: File or Array of Files.
folioMetadata	Meta data for the folio. Can accept: Ordered array containing key:String, value:String.
exportFolioParams	Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

exportMiniFolio(

destination, portraitDocument, landscapeDocument, folioMetadata, miniFolioParams)

→ 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	Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional)
miniFolioParams	Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

exportPresets(

format, to ​[, versionComments] ​[, forceSave=false])

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. (Optional)
forceSave	bool Forcibly save a version. (Optional)

exportSelectionForCloudLibrary(

to)

→ bool

Exports selection as assets required for cloud library.

to	File The path to the export file.

exportStrokeStyles(

to, strokeStyleList ​[, versionComments] ​[, forceSave=false])

Exports stroke styles or presets.

to	File The file to save to
strokeStyleList	Array<StrokeStyle> The list of stroke styles to save
versionComments	string The comment for this version (Optional)
forceSave	bool Forcibly save a version (Optional)

extractLabel(

key)

→ string

Gets the label value associated with the specified key.

key	string The key.

findGlyph(

[reverseOrder])

→ Text

Finds glyphs that match the find what value.

reverseOrder

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

findGrep(

[reverseOrder])

→ Text

Finds text that matches the find what value.

reverseOrder

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

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

for	string The string to search for.

findObject(

[reverseOrder])

→ PageItem

Finds objects that match the find what value.

reverseOrder

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

findText(

[reverseOrder])

→ Text

Finds text that matches the find what value.

reverseOrder

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

findTransliterate(

[reverseOrder])

→ Text

Finds text that matches the find character type value.

reverseOrder

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

generateIDMLSchema(

to ​[, packageFormat])

Generate schema for IDML.

to	File The folder path of the schema.
packageFormat	bool If true, generate schema for package format (multiple files). Default value is false. (Optional)

getAllOverlays(

portraitDocumentForCheckingOverlays, landscapeDocumentForCheckingOverlays, miniFolioParams)

Get all overlays.

portraitDocumentForCheckingOverlays	Document The portrait document for checking overlays.
landscapeDocumentForCheckingOverlays	Document The landscape document for checking overlays.
miniFolioParams	Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional)

getCCXUserJSONData(

[jsondata])

→ string

Get a JSON string for the CCX Welcome dialog.

jsondata

string mode description (Optional)

getDigpubArticleVersion(

digpubArticleVersion)

→ string

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

digpubArticleVersion

DigpubArticleVersion Version string(s) to retrieve.

getDigpubVersion(

digpubVersion)

→ string

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

digpubVersion

DigpubVersion Version string(s) to retrieve.

getElements(

)

→ Application

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

getStyleConflictResolutionStrategy(

[charOrParaStyle])

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

charOrParaStyle

StyleType Style type to look at. (Optional)

getSupportedArticleViewerVersions(

)

→ string

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

getSupportedViewerVersions(

)

→ string

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

getUntitledCount(

)

→ number

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

getUserChoiceForCloudTextAddition(

)

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

importAdobeSwatchbookProcessColor(

name)

→ Color

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

name	string The process color to load.

importAdobeSwatchbookSpotColor(

name)

→ Color

Imports a spot color swatch from an Adobe color book.

name	string The spot color to load.

importFile(

format, from)

Imports presets from the specified file.

format	ExportPresetFormat The type of preset to import.
from	File The file to import presets from.

importStyles(

format, from ​[, globalStrategy=GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE])

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

insertLabel(

key, value)

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

key	string The key.
value	string The value.

invokeColorPicker(

space, colorValue)

→ string

Invokes InDesign's Color Picker.

space	ColorSpace Color space RGB, CMYK or LAB
colorValue	Array<number> Color values

isAppInTouchMode(

)

→ bool

Whether the app is in touch mode or not.

isUserSharingAppUsageData(

)

→ bool

Whether user has opted-in to share usage data.

k4GetK4PreferenceReportNewAssignments(

)

→ bool

K4 Get K4-Preferences Report New Assignments

k4GetShowArticleColorsState(

)

→ bool

K4 Get Show Article Colors State

k4GetShowFrameIconsState(

)

→ bool

K4 Get Show Frame Icons State

k4GetShowFrameToolTipsState(

)

→ bool

K4 Get Show Frame Tools Tips State

k4HandleUrl(

k4Url)

K4 Handle Url

k4Url

string K4 Url

k4LogIn(

k4UserName, k4Password, k4Domain)

K4 Log In

k4UserName	string K4 User Name
k4Password	string K4 Password
k4Domain	string K4 Domain

k4LogInToPublication(

k4PublicationID, k4UserName, k4Password, k4Domain)

K4 Log In To Publication

k4PublicationID	string K4 Publication ID
k4UserName	string K4 User Name
k4Password	string K4 Password
k4Domain	string K4 Domain

k4LogOutFromAll(

)

K4 Log Out From All Publications

k4SetArticleColorsState(

show)

K4 Set Article Colors State

show

bool Show

k4SetFrameIconsState(

show)

K4 Set Frame Icons State

show

bool Show

k4SetFrameToolTipsState(

show)

K4 Set Frame Tool Tips State

show

bool Show

k4SetK4PreferenceReportNewAssignments(

k4ReportNewAssignment)

K4 Set K4-Preferences Report New Assignments

k4ReportNewAssignment

bool K4 Report New Assignment

k4SwitchGeometry(

k4PublicationId, k4WfObjectVariantId)

K4 Switch Geometry

k4PublicationId	string K4 Publication ID
k4WfObjectVariantId	string K4 Workflow Object Variant ID

k4UpdateGeometry(

k4PublicationId, k4WfObjectVariantId)

K4 Update Geometry

k4PublicationId	string K4 Publication ID
k4WfObjectVariantId	string K4 Workflow Object Variant ID

k4internalacceptalltasksforobject(

publicationid, wfobjectvariantid)

K4 Internal Accept All Tasks For Object

publicationid	string publication ID
wfobjectvariantid	string Workflow object variant id

k4internalaccepttasksforobject(

publicationid, wfobjectvariantid, taskinstanceids)

K4 Internal Accept Tasks For Object

publicationid	string publication ID
wfobjectvariantid	string Workflow object variant id
taskinstanceids	Array<string> Task Instance IDs

loadConditions(

from ​[, loadConditionSets])

Load conditions from the specified file.

from	File The path to the file that contains the conditions.
loadConditionSets	bool If true, load the condition sets as well. (Optional)

loadFindChangeQuery(

queryName, searchMode)

Loads the specified find/change query.

queryName	string The query to load.
searchMode	SearchModes The search mode.

loadMotionPreset(

from)

→ MotionPreset

Load motion preset from the specified file.

from	File The Flash motion preset file.

loadPreflightProfile(

from)

→ PreflightProfile

Load preflight profile from the specified file.

from	File The InDesign preflight profile file or InDesign document.

loadSwatches(

from)

Load swatches from the specified file.

from	File The swatch file or InDesign document.

loadXMLTags(

from)

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

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

memoryStatistics(

)

Gets the memory statistics from the server.

mountProject(

serverURL, projectName)

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

open(

from ​[, showingWindow=true] ​[, openOption=OpenOptions.DEFAULT_VALUE])

Opens the specified document, book, or library.

from	The file path(s) to the document, book, or library. Can accept: File or Array of Files.
showingWindow	bool If true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional)
openOption	OpenOptions How to open the document. (Optional)

openCloudAssetForEdit(

jsondata)

→ bool

Opens the cloud library asset for editing.

jsondata

string JSON encoded information about the asset to be edited.

openPanel(

id)

Open the panel associated with the action.

id	number The ID.

packageUCF(

sourceFolder, ucfFile ​[, mimeMediaType="application/vnd.adobe.indesign-idml-package"])

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

paste(

)

Pastes data from the clipboard into the active document window.

pasteInPlace(

)

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

pasteInto(

)

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

pasteWithoutFormatting(

)

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

performanceMetric(

for)

Gets the current value of the specified performance metric.

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

performanceMetricLongName(

for)

→ string

Gets the long name of the specified performance metric.

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

performanceMetricShortName(

for)

→ string

Gets the short name of the specified performance metric.

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

place(

fileName ​[, showingOptions=false] ​[, withProperties])

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	One or more files to place. Can accept: File or Array of Files.
showingOptions	bool Whether to display the import options dialog (Optional)
withProperties	Object Initial values for properties of the placed object(s) (Optional)

print(

from ​[, printDialog], using)

Prints the specified file(s).

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

quit(

[saving=SaveOptions.ASK])

Quits the application.

saving

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

redo(

)

Redoes the last action.

removeEventListener(

eventType, handler ​[, captures=false])

→ bool

Removes the event listener.

eventType	string The registered event type.
handler	The registered event handler. Can accept: File or JavaScript Function.
captures	bool This parameter is obsolete. (Optional)

removeFileFromRecentFiles(

to)

→ bool

Remove the file from most recently used files

to	File The file to be removed

saveFindChangeQuery(

queryName, searchMode)

Saves the specified find/change query.

queryName	string The query to save.
searchMode	SearchModes The search mode.

saveSwatches(

to, swatchList ​[, versionComments] ​[, forceSave=false])

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

to	File The swatchbook file to save to.
swatchList	Array<Swatch> The swatch(es) to save.
versionComments	string The comment for this version. (Optional)
forceSave	bool If true, forcibly saves a version. (Optional)

saveXMLTags(

to ​[, versionComments] ​[, forceSave=false])

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. (Optional)
forceSave	bool If true, forcibly saves a version. (Optional)

select(

selectableItems ​[, existingSelection=SelectionOptions.REPLACE_WITH])

Selects the specified object(s).

selectableItems	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. (Optional)

setApplicationPreferences(

applicationPreferences)

Sets the application's preferences.

applicationPreferences

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

setCloudLibraryCollection(

librariesCollectionInfo)

Set cloud libraries info.

librariesCollectionInfo

string JSON encoded information about cloud libraries collection

setCloudLibraryOptions(

maxwidth, maxheight)

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.

setUntitledCount(

untitledCount)

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

tileWindows(

)

Tile all document windows

toSource(

)

→ string

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

toSpecifier(

)

→ string

Retrieves the object specifier.

togglePanelSystemVisibility(

)

Toggles the visibility of the entire panel system.

translateKeyString(

for)

→ string

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

for	string The key string to translate

undo(

)

Undoes the last action.

unpackageUCF(

ucfFile, destinationFolder)

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.

updateFonts(

)

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

waitForAllTasks(

)

→ TaskState

Waits for all the background tasks to finish.