Application
QuickLinks
Hierarchy
Properties
Property | Type | Access | Description |
---|---|---|---|
activeDocument | Document | r/w | The front-most document. |
activeScript | File | readonly | The current script running from the Scripts panel. |
activeScriptUndoMode | UndoModes: UndoModes.SCRIPT_REQUEST UndoModes.ENTIRE_SCRIPT UndoModes.AUTO_UNDO UndoModes.FAST_ENTIRE_SCRIPT |
readonly | The undo mode for the current script execution. |
activeWindow | Window | r/w | The front-most window. |
allCellStyles | Array of CellStyle | readonly | All Cell styles |
allCharacterStyles | Array of CharacterStyle | readonly | Lists all character styles (regardless of their group). |
allParagraphStyles | Array of ParagraphStyle | readonly | Lists all paragraph styles (regardless of their group). |
allTableStyles | Array of TableStyle | readonly | All Table styles |
anchoredObjectDefaults | AnchoredObjectDefault | readonly | Anchored object default settings. |
anchoredObjectSettings | AnchoredObjectSetting | readonly | Anchored object settings. |
autoCorrectPreferences | AutoCorrectPreference | readonly | Auto-correct preferences. |
autoCorrectTables | AutoCorrectTables | readonly | A collection of auto-correct tables. |
autoExpandTextMacros | bool | r/w | If true, expands text macros automatically when the macro is typed in the document. If false, the macro remains as typed. |
backgroundTasks | BackgroundTasks | readonly | A collection of background task objects. |
baselineFrameGridOptions | BaselineFrameGridOption | readonly | Baseline frame grid option settings. |
cellStyleGroups | CellStyleGroups | readonly | A collection of cell style groups. |
cellStyles | CellStyles | readonly | A collection of cell styles. |
changeGlyphPreferences | ChangeGlyphPreference NothingEnum |
r/w | Change glyph preferences. Can also accept: NothingEnum enumerator. |
changeGrepPreferences | ChangeGrepPreference NothingEnum |
r/w | Change grep preferences. Can also accept: NothingEnum enumerator. |
changeTextPreferences | ChangeTextPreference NothingEnum |
r/w | Change text preferences. Can also accept: NothingEnum enumerator. |
changeTransliteratePreferences | ChangeTransliteratePreference NothingEnum |
r/w | Change transliterate preferences. Can also accept: NothingEnum enumerator. |
characterStyleGroups | CharacterStyleGroups | readonly | A collection of character style groups. |
characterStyles | CharacterStyles | readonly | A collection of character styles. |
clipboardPreferences | ClipboardPreference | readonly | Clipboard preference properties that define the way that the application interacts with the system clipboard. |
colors | Colors | readonly | A collection of colors. |
conditionSets | ConditionSets | readonly | A collection of condition sets for conditional text. |
conditionalTextPreferences | ConditionalTextPreference | readonly | Conditional text preferences. |
conditions | Conditions | readonly | A collection of conditions for conditional text. |
dialogs | Dialogs | readonly | A collection of dialogs. |
dictionaryPreferences | DictionaryPreference | readonly | User dictionary preference settings. |
documentPreferences | DocumentPreference | readonly | Document preference settings. |
documentPresets | DocumentPresets | readonly | A collection of document presets. |
documents | Documents | readonly | A collection of documents. |
eventListeners | EventListeners | readonly | A collection of event listeners. |
events | Events | readonly | A collection of events. |
excelImportPreferences | ExcelImportPreference | readonly | Excel import preferences. |
exportForWebPreferences | ExportForWebPreference | readonly | The default export for web preferences. |
featureSet | FeatureSetOptions: FeatureSetOptions.ROMAN FeatureSetOptions.JAPANESE FeatureSetOptions.RIGHTTOLEFT |
readonly | The feature set. |
filePath | File | readonly | The full path to the file. |
findChangeGlyphOptions | FindChangeGlyphOption NothingEnum |
r/w | Find/change glyph options. Can also accept: NothingEnum enumerator. |
findChangeGrepOptions | FindChangeGrepOption NothingEnum |
r/w | Find/change grep options. Can also accept: NothingEnum enumerator. |
findChangeObjectOptions | FindChangeObjectOption NothingEnum |
r/w | Find/change object options. Can also accept: NothingEnum enumerator. |
findChangeTextOptions | FindChangeTextOption NothingEnum |
r/w | Find/change text options. Can also accept: NothingEnum enumerator. |
findChangeTransliterateOptions | FindChangeTransliterateOption NothingEnum |
r/w | Find/change transliterate options. Can also accept: NothingEnum enumerator. |
findGlyphPreferences | FindGlyphPreference NothingEnum |
r/w | Find glyph preferences. Can also accept: NothingEnum enumerator. |
findGrepPreferences | FindGrepPreference NothingEnum |
r/w | Find grep preferences. Can also accept: NothingEnum enumerator. |
findTextPreferences | FindTextPreference NothingEnum |
r/w | Find text preferences. Can also accept: NothingEnum enumerator. |
findTransliteratePreferences | FindTransliteratePreference NothingEnum |
r/w | Find transliterate preferences. Can also accept: NothingEnum enumerator. |
fonts | Fonts | 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. |
galleyPDFExportPreferences | PDFGalleyExportPreference | readonly | PDF galley export preference settings. |
galleyPreferences | GalleyPreference | readonly | Galley preference settings. |
galleyPrintPreferences | GalleyPrintPreference | readonly | Galley print preferences. |
generalPreferences | GeneralPreference | readonly | General preference settings. |
gradients | Gradients | readonly | A collection of gradients. |
gridPreferences | GridPreference | readonly | Grid preference settings. |
guidePreferences | GuidePreference | readonly | Guide preference settings. |
idleTasks | IdleTasks | 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. |
indexingSortOptions | IndexingSortOptions | readonly | A collection of indexing sort options. |
inks | Inks | readonly | A collection of inks. |
isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
kinsokuTables | KinsokuTables | readonly | A collection of kinsoku tables. |
label | string | r/w | A property that can be set to any string. |
languagesWithVendors | LanguagesWithVendors | readonly | A collection of languages with vendors. |
layoutPDFExportPreferences | PDFLayoutExportPreference | readonly | PDF layout export preference settings. |
layoutPrintPreferences | LayoutPrintPreference | readonly | Layout print preferences. |
linkingPreferences | LinkingPreference | readonly | The links preference properties that define preferences for links. |
liveScreenDrawing | LiveDrawingOptions: LiveDrawingOptions.NEVER LiveDrawingOptions.IMMEDIATELY LiveDrawingOptions.DELAYED |
r/w | Delay before mouse operations trigger live screen drawing of page items. |
locale | Locale: Locale.DANISH_LOCALE Locale.ENGLISH_LOCALE Locale.INTERNATIONAL_ENGLISH_LOCALE Locale.FINNISH_LOCALE Locale.FRENCH_LOCALE Locale.GERMAN_LOCALE Locale.ITALIAN_LOCALE Locale.PORTUGUESE_LOCALE Locale.SPANISH_LOCALE Locale.SWEDISH_LOCALE Locale.JAPANESE_LOCALE Locale.ARABIC_LOCALE Locale.CZECH_LOCALE Locale.GREEK_LOCALE Locale.HEBREW_LOCALE Locale.HUNGARIAN_LOCALE Locale.POLISH_LOCALE Locale.ROMANIAN_LOCALE Locale.RUSSIAN_LOCALE Locale.TURKISH_LOCALE Locale.UKRAINIAN_LOCALE Locale.KOREAN_LOCALE Locale.SIMPLIFIED_CHINESE_LOCALE Locale.TRADITIONAL_CHINESE_LOCALE |
readonly | The locale of the application. |
marginPreferences | MarginPreference | readonly | Margin preference settings. |
menuActions | MenuActions | readonly | A collection of menu actions. |
menus | Menus | readonly | A collection of menus. |
mixedInkGroups | MixedInkGroups | readonly | A collection of mixed ink groups. |
mixedInks | MixedInks | readonly | A collection of mixed inks. |
modalState | bool | readonly | If true, a modal dialog or alert is active. |
mojikumiTables | MojikumiTables | readonly | A collection of mojikumi tables. |
mojikumiUIPreferences | MojikumiUiPreference | readonly | Mojikumi user interface preference settings. |
name | string | readonly | The name of the Application. |
notePreferences | NotePreference | readonly | Note preference settings. |
numberingLists | NumberingLists | readonly | A collection of numbered lists. |
pageItemDefaults | PageItemDefault | readonly | The default page item formatting for the Application. |
panels | Panels | readonly | A collection of panels. |
paragraphStyleGroups | ParagraphStyleGroups | readonly | A collection of paragraph style groups. |
paragraphStyles | ParagraphStyles | readonly | A collection of paragraph styles. |
parent | Application | readonly | The parent of the Application (a Application). |
pasteboardPreferences | PasteboardPreference | readonly | Pasteboard preference settings. |
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. |
preferences | Preferences | readonly | A collection of preferences objects. |
properties | Object | r/w | 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 | readonly | A collection of script menu actions. |
scriptPreferences | ScriptPreference | readonly | Script preferences. |
selection | Array of Object | r/w | The selected object(s). Can also accept: Object or NothingEnum enumerator. |
serialNumber | string | readonly | The user's serial number. |
spellPreferences | SpellPreference | readonly | Spell-check preferences. |
storyPreferences | StoryPreference | readonly | Story preference settings. |
strokeFillProxySettings | StrokeFillProxySetting | readonly | Stroke/fill proxy settings. |
strokeStyles | StrokeStyles | readonly | A collection of stroke styles. |
swatches | Swatches | readonly | A collection of swatches. |
tableStyleGroups | TableStyleGroups | readonly | A collection of table style groups. |
tableStyles | TableStyles | readonly | A collection of table styles. |
taggedTextExportPreferences | TaggedTextExportPreference | readonly | Tagged text export preferences. |
taggedTextImportPreferences | TaggedTextImportPreference | readonly | Tagged text import preferences. |
textDefaults | TextDefault | readonly | Text default settings. |
textEditingPreferences | TextEditingPreference | readonly | Text editing preference settings. |
textExportPreferences | TextExportPreference | readonly | Text export preferences. |
textFramePreferences | TextFramePreference | readonly | Text frame preference settings. |
textImportPreferences | TextImportPreference | readonly | Text import preferences. |
textMacros | TextMacros | readonly | A collection of text macros. |
textPreferences | TextPreference | readonly | Text preference settings. |
textVariables | TextVariables | 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 | readonly | A collection of tints. |
toolBoxTools | ToolBox | readonly | The current tool box states |
trackChangesPreferences | TrackChangesPreference | readonly | Track changes preference settings. |
transformationMatrices | TransformationMatrices | readonly | A collection of transformation matrices. |
trapPresets | TrapPresets | readonly | A collection of trap presets. |
undoHistory | Array of string | readonly | The names of the items in the undo stack. |
undoName | string | readonly | The name of the action on the top of the undo stack. |
unusedSwatches | Array of Swatch | readonly | The swatches that are not being used. |
userColor | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | readonly | A collection of user dictionaries. |
userName | string | r/w | The user associated with the tracked changes and notes. |
version | string | readonly | The application version. |
viewPreferences | ViewPreference | readonly | View preference settings. |
visible | bool | readonly | If true, the Application is visible. |
windows | Windows | readonly | A collection of windows. |
wordRTFImportPreferences | WordRTFImportPreference | readonly | Word and RTF import preferences. |
xmlExportMaps | XMLExportMaps | readonly | A collection of XML export maps. |
xmlExportPreferences | XMLExportPreference | readonly | XML export preference settings. |
xmlImportMaps | XMLImportMaps | readonly | A collection of XML import maps. |
xmlImportPreferences | XMLImportPreference | readonly | XML import preference settings. |
xmlPreferences | XMLPreference | readonly | The XML preference settings. |
xmlTags | XMLTags | readonly | A collection of XML tags. |
xmlViewPreferences | XMLViewPreference | readonly | XML view preference settings. |
Class
Property | Type | Access | Description |
---|---|---|---|
AFTER_ACTIVATE | string | readonly | Dispatched after the Application becomes active. This event bubbles. This event is not cancelable. (default: afterActivate) |
AFTER_CLOSE | string | readonly | Dispatched after a Document is closed. This event bubbles. This event is not cancelable. (default: afterClose) |
AFTER_CONTEXT_CHANGED | string | readonly | Dispatched after the active context changes. This event bubbles. This event is not cancelable. (default: afterContextChanged) |
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. (default: afterQuit) |
AFTER_SELECTION_ATTRIBUTE_CHANGED | string | readonly | Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionAttributeChanged) |
AFTER_SELECTION_CHANGED | string | readonly | Dispatched after the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionChanged) |
BEFORE_DEACTIVATE | string | readonly | Dispatched before the Application becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate) |
BEFORE_NEW | string | readonly | Dispatched before a Document is created. This event bubbles. This event is cancelable. (default: beforeNew) |
BEFORE_OPEN | string | readonly | Dispatched before a Document is opened. This event bubbles. This event is cancelable. (default: beforeOpen) |
BEFORE_QUIT | string | readonly | Dispatched before the Application is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable. (default: beforeQuit) |
Methods
Instances
void activate ()
Makes the application the front-most or active window.
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The event type. |
handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
void applyMenuCustomization ([name:
string])
Applies the specified menu customization set. An empty string will reset all menus and colorization (Show Full Menus). No string will apply the default menu set.
Parameter | Type | Description |
---|---|---|
name | string | The menu customization set. (Optional) |
void 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) |
void applyWorkspace ([name:
string])
Applies the specified workspace.
Parameter | Type | Description |
---|---|---|
name | string | The workspace. (Optional) |
void cancelAllTasks ()
Cancels all the background tasks.
void cascadeWindows ()
Cascades all document windows.
Array
of Text changeGlyph ([reverseOrder:
bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of Text changeGrep ([reverseOrder:
bool])
Finds text that matches the find what value and replaces the text with the change to value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of PageItem changeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of Text changeText ([reverseOrder:
bool])
Finds text that matches the find what value and replaces the text with the change to value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of Text changeTransliterate ([reverseOrder:
bool])
Finds text that matches the find character type value and replaces the text with the change character type value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void copy ()
Copies the selection in the active document window to the clipboard.
void cut ()
Cuts the selection in the active document window and stores it in the clipboard.
void deleteFindChangeQuery (queryName:
string, searchMode:
SearchModes)
Deletes the specified find/change query.
Parameter | Type | Description |
---|---|---|
queryName | string | The query to delete. |
searchMode | SearchModes: SearchModes.TEXT_SEARCH SearchModes.GREP_SEARCH SearchModes.GLYPH_SEARCH SearchModes.OBJECT_SEARCH | The search mode. |
void deleteUnusedTags ()
Deletes unused XML markup tags.
any doScript (script:
varies[, language:
ScriptLanguage=ScriptLanguage.UNKNOWN][, withArguments:
Array
of any][, undoMode:
UndoModes=UndoModes.SCRIPT_REQUEST][, undoName:
string=Script])
Executes the script in the specified language as a single transaction.
Parameter | Type | Description |
---|---|---|
script | File JavaScript Function String | The script to execute. Can accept: File, String or JavaScript Function. |
language | ScriptLanguage: ScriptLanguage.UNKNOWN ScriptLanguage.JAVASCRIPT ScriptLanguage.APPLESCRIPT_LANGUAGE | The language of the script to execute. If not specified, uses the language used to call this method. (Optional) (default: ScriptLanguage.UNKNOWN) |
withArguments | Array of any | An array of arguments passed to the script. (Optional) |
undoMode | UndoModes: UndoModes.SCRIPT_REQUEST UndoModes.ENTIRE_SCRIPT UndoModes.AUTO_UNDO UndoModes.FAST_ENTIRE_SCRIPT | 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: Script) |
void dumpBetweenMemoryMarks (from:
number, to:
number)
Dumps memory allocations from all marks in the specified range.
Parameter | Type | Description |
---|---|---|
from | number | The first mark in the range. |
to | number | The last mark in the range. |
void dumpFromMemoryMark (from:
number)
Dumps memory allocations from the specified mark.
Parameter | Type | Description |
---|---|---|
from | number | The mark from which to dump memory. |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
Array
of Text findGlyph ([reverseOrder:
bool])
Finds glyphs that match the find what value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of Text findGrep ([reverseOrder:
bool])
Finds text that matches the find what value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of string findKeyStrings (for:
string)
Returns the locale-independent string(s) from the internal string localization database that correspond to the specified string (in the current locale).
Parameter | Type | Description |
---|---|---|
for | string | The string to search for. |
Array
of PageItem findObject ([reverseOrder:
bool])
Finds objects that match the find what value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of Text findText ([reverseOrder:
bool])
Finds text that matches the find what value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
Array
of Text findTransliterate ([reverseOrder:
bool])
Finds text that matches the find character type value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void generateIDMLSchema (to:
File[, packageFormat:
bool])
Generate schema for IDML.
Parameter | Type | Description |
---|---|---|
to | File | The folder path of the schema. |
packageFormat | bool | If true, generate schema for package format (multiple files). Default value is false. (Optional) |
Array
of Application getElements ()
Resolves the object specifier, creating an array of object references.
Color importAdobeSwatchbookProcessColor (name:
string)
Imports a process color swatch from a preloaded Adobe color book.
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. |
void importStyles (format:
ImportFormat, from:
File[, globalStrategy:
GlobalClashResolutionStrategy=GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE])
Imports the specified styles.
Parameter | Type | Description |
---|---|---|
format | ImportFormat: ImportFormat.CHARACTER_STYLES_FORMAT ImportFormat.PARAGRAPH_STYLES_FORMAT ImportFormat.TEXT_STYLES_FORMAT ImportFormat.TABLE_STYLES_FORMAT ImportFormat.CELL_STYLES_FORMAT ImportFormat.TABLE_AND_CELL_STYLES_FORMAT | The types of styles to import. |
from | File | The file containing the styles you want to import. |
globalStrategy | GlobalClashResolutionStrategy: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE | The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) (default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE) |
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
value | string | The value. |
void loadConditions (from:
File[, loadConditionSets:
bool])
Load conditions from the specified file.
Parameter | Type | Description |
---|---|---|
from | File | The path to the file that contains the conditions. |
loadConditionSets | bool | If true, load the condition sets as well. (Optional) |
void loadFindChangeQuery (queryName:
string, searchMode:
SearchModes)
Loads the specified find/change query.
Parameter | Type | Description |
---|---|---|
queryName | string | The query to load. |
searchMode | SearchModes: SearchModes.TEXT_SEARCH SearchModes.GREP_SEARCH SearchModes.GLYPH_SEARCH SearchModes.OBJECT_SEARCH | The search mode. |
void loadSwatches (from:
File)
Load swatches from the specified file.
Parameter | Type | Description |
---|---|---|
from | File | The swatch file or InDesign document. |
void 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. |
Array
of number memoryStatistics ()
Gets the memory statistics from the server.
void 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 |
any open (from:
varies[, showingWindow:
bool=true][, openOption:
OpenOptions=OpenOptions.DEFAULT_VALUE])
Opens the specified document.
Parameter | Type | Description |
---|---|---|
from |
Array
of Files File | The file path(s) to the document. 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) (default: true) |
openOption | OpenOptions: OpenOptions.DEFAULT_VALUE OpenOptions.OPEN_ORIGINAL OpenOptions.OPEN_COPY | How to open the document. (Optional) (default: OpenOptions.DEFAULT_VALUE) |
void packageUCF (sourceFolder:
File, ucfFile:
File[, mimeMediaType:
string=application/vnd.adobe.indesign-idml-package])
Package a folder into a UCF file.
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) |
void paste ()
Pastes data from the clipboard into the active document window.
void pasteInPlace ()
Pastes data from the clipboard into the active document window at the same position that the data held in its original document.
void pasteInto ()
Pastes data from the clipboard into the selected object in the active document window.
void pasteWithoutFormatting ()
Pastes data (minus formatting) from the clipboard into the active document window.
any performanceMetric (for:
varies)
Gets the current value of the specified performance metric.
Parameter | Type | Description |
---|---|---|
for | Long Integer PerformanceMetricOptions | The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. |
string performanceMetricLongName (for:
varies)
Gets the long name of the specified performance metric.
Parameter | Type | Description |
---|---|---|
for | Long Integer PerformanceMetricOptions | The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. |
string performanceMetricShortName (for:
varies)
Gets the short name of the specified performance metric.
Parameter | Type | Description |
---|---|---|
for | Long Integer PerformanceMetricOptions | The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. |
void print (from:
varies[, printDialog:
bool])
Prints the specified file(s).
Parameter | Type | Description |
---|---|---|
from |
Array
of Files File | One or more file paths. Can accept: File or Array of Files. |
printDialog | bool | Whether to invoke the print dialog (Optional) |
void quit ([saving:
SaveOptions=SaveOptions.ASK])
Quits the application.
Parameter | Type | Description |
---|---|---|
saving | SaveOptions: SaveOptions.NO SaveOptions.ASK SaveOptions.YES | The option to use for saving changes to open documents before quitting. (Optional) (default: SaveOptions.ASK) |
void redo ()
Redoes the last action.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The registered event type. |
handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
void saveFindChangeQuery (queryName:
string, searchMode:
SearchModes)
Saves the specified find/change query.
Parameter | Type | Description |
---|---|---|
queryName | string | The query to save. |
searchMode | SearchModes: SearchModes.TEXT_SEARCH SearchModes.GREP_SEARCH SearchModes.GLYPH_SEARCH SearchModes.OBJECT_SEARCH | The search mode. |
void saveSwatches (to:
File, swatchList:
Array
of Swatch[, versionComments:
string][, forceSave:
bool=false])
Saves the specified swatch(es) to a swatchbook file.
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 | bool | If true, forcibly saves a version. (Optional) (default: false) |
void saveXMLTags (to:
File[, versionComments:
string][, forceSave:
bool=false])
Saves a set of tags to an external file.
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 | bool | If true, forcibly saves a version. (Optional) (default: false) |
void select (selectableItems:
varies[, existingSelection:
SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).
Parameter | Type | Description |
---|---|---|
selectableItems |
Array
of Objects NothingEnum Object SelectAll | The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. |
existingSelection | SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH | The selection status of the Application in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
void setApplicationPreferences (applicationPreferences:
varies)
Sets the application's preferences.
Parameter | Type | Description |
---|---|---|
applicationPreferences | File LanguageAndRegion | The IDML defaults file or enumeration. Can accept: File or LanguageAndRegion enumerator. |
void tileWindows ()
Tile all document windows
string toSource ()
Generates a string which, if executed, will return the Application.
string toSpecifier ()
Retrieves the object specifier.
void togglePanelSystemVisibility ()
Toggles the visibility of the entire panel system.
string translateKeyString (for:
string)
Translates a key string into localized form based on current application locale.
Parameter | Type | Description |
---|---|---|
for | string | The key string to translate |
void undo ()
Undoes the last action.
void 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. |
void updateFonts ()
Forces a check for new fonts in the various Fonts folders.
Array
of TaskState waitForAllTasks ()
Waits for all the background tasks to finish.
Element of
AnchoredObjectDefault.parent
Application.parent
AutoCorrectPreference.parent
AutoCorrectTable.parent
BackgroundTask.parent
CellStyle.parent
CellStyleGroup.parent
ChangeGlyphPreference.parent
ChangeGrepPreference.parent
ChangeTextPreference.parent
ChangeTransliteratePreference.parent
CharacterStyle.parent
CharacterStyleGroup.parent
ClipboardPreference.parent
Color.parent
Condition.parent
ConditionSet.parent
ConditionalTextPreference.parent
Dialog.parent
DictionaryPreference.parent
Document.parent
DocumentEvent.parent
DocumentPreference.parent
DocumentPreset.parent
ExcelImportPreference.parent
ExportForWebPreference.parent
FindChangeGlyphOption.parent
FindChangeGrepOption.parent
FindChangeObjectOption.parent
FindChangeTextOption.parent
FindChangeTransliterateOption.parent
FindGlyphPreference.parent
FindGrepPreference.parent
FindTextPreference.parent
FindTransliteratePreference.parent
Font.parent
FootnoteOption.parent
FrameFittingOption.parent
GalleyPreference.parent
GalleyPrintPreference.parent
GeneralPreference.parent
Gradient.parent
GridPreference.parent
GuidePreference.parent
IMEPreference.parent
IdleTask.parent
ImageIOPreference.parent
ImagePreference.parent
ImportExportEvent.parent
ImportedPageAttribute.parent
IndexingSortOption.parent
Ink.parent
KinsokuTable.parent
LanguageWithVendors.parent
LayoutPrintPreference.parent
LinkingPreference.parent
Menu.parent
MenuAction.parent
MixedInk.parent
MixedInkGroup.parent
MojikumiTable.parent
MojikumiUiPreference.parent
NotePreference.parent
NumberingList.parent
PDFGalleyExportPreference.parent
PDFLayoutExportPreference.parent
PageItemDefault.parent
Panel.parent
ParagraphStyle.parent
ParagraphStyleGroup.parent
PasteboardPreference.parent
ScriptArg.parent
ScriptMenuAction.parent
ScriptPreference.parent
SpellPreference.parent
StrokeFillProxySetting.parent
StrokeStyle.parent
Swatch.parent
TableStyle.parent
TableStyleGroup.parent
TaggedTextExportPreference.parent
TaggedTextImportPreference.parent
TextDefault.parent
TextEditingPreference.parent
TextExportPreference.parent
TextImportPreference.parent
TextMacro.parent
TextPreference.parent
TextVariable.parent
TextWrapPreference.parent
Tint.parent
ToolBox.parent
TrackChangesPreference.parent
TransformationMatrix.parent
TrapPreset.parent
UserDictionary.parent
ViewPreference.parent
WordRTFImportPreference.parent
XMLExportMap.parent
XMLExportPreference.parent
XMLImportMap.parent
XMLImportPreference.parent
XMLPreference.parent
XMLTag.parent
XMLViewPreference.parent
Return
Array of Application Application.getElements ()
Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |