Adobe InCopy CS5.5 (7.5) Object Model JS: Application

InCopy CS5.5

Class

Application

 The application.

QuickLinks

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

Hierarchy

Application
Application
AnchoredObjectDefault | AnchoredObjectSetting | Application | AutoCorrectPreference | AutoCorrectTable | BackgroundTask | BaselineFrameGridOption | CellStyle | CellStyleGroup | ChangeGlyphPreference | ChangeGrepPreference | ChangeTextPreference | ChangeTransliteratePreference | CharacterStyle | CharacterStyleGroup | ClipboardPreference | Color | Condition | ConditionSet | ConditionalTextPreference | Dialog | DictionaryPreference | Document | DocumentEvent | DocumentPreference | DocumentPreset | Event | EventListener | ExcelImportPreference | ExportForWebPreference | FindChangeGlyphOption | FindChangeGrepOption | FindChangeObjectOption | FindChangeTextOption | FindChangeTransliterateOption | FindGlyphPreference | FindGrepPreference | FindTextPreference | FindTransliteratePreference | Font | FootnoteOption | FrameFittingOption | GalleyPreference | GalleyPrintPreference | GeneralPreference | Gradient | GridPreference | GuidePreference | IMEPreference | IdleTask | ImageIOPreference | ImagePreference | ImportExportEvent | ImportedPageAttribute | InCopyExportOption | IndexingSortOption | Ink | KinsokuTable | LanguageWithVendors | LayoutPrintPreference | LinkingPreference | MarginPreference | Menu | MenuAction | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | MutationEvent | NotePreference | NumberingList | PDFGalleyExportPreference | PDFLayoutExportPreference | PageItemDefault | Panel | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | Preference | ScriptArg | ScriptMenuAction | ScriptPreference | SpellPreference | StoryPreference | StrokeFillProxySetting | StrokeStyle | Swatch | TableStyle | TableStyleGroup | TaggedTextExportPreference | TaggedTextImportPreference | TextDefault | TextEditingPreference | TextExportPreference | TextFramePreference | TextImportPreference | TextMacro | TextPreference | TextVariable | TextWrapPreference | Tint | ToolBox | TrackChangesPreference | TransformationMatrix | TrapPreset | UserDictionary | ViewPreference | WordRTFImportPreference | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLPreference | XMLTag | XMLViewPreference

Properties

PropertyTypeAccessDescription
activeDocumentDocument r/wThe front-most document.
activeScriptFile readonlyThe current script running from the Scripts panel.
activeScriptUndoModeUndoModes:
UndoModes.SCRIPT_REQUEST
UndoModes.ENTIRE_SCRIPT
UndoModes.AUTO_UNDO
UndoModes.FAST_ENTIRE_SCRIPT
readonlyThe undo mode for the current script execution.
activeWindowWindow r/wThe front-most window.
allCellStyles Array of CellStyle readonlyAll Cell styles
allCharacterStyles Array of CharacterStyle readonlyLists all character styles (regardless of their group).
allParagraphStyles Array of ParagraphStyle readonlyLists all paragraph styles (regardless of their group).
allTableStyles Array of TableStyle readonlyAll Table styles
anchoredObjectDefaultsAnchoredObjectDefault readonlyAnchored object default settings.
anchoredObjectSettingsAnchoredObjectSetting readonlyAnchored object settings.
autoCorrectPreferencesAutoCorrectPreference readonlyAuto-correct preferences.
autoCorrectTablesAutoCorrectTables AutoCorrectTable readonlyA collection of auto-correct tables.
autoExpandTextMacrosbool r/wIf true, expands text macros automatically when the macro is typed in the document. If false, the macro remains as typed.
backgroundTasksBackgroundTasks BackgroundTask readonlyA collection of background task objects.
baselineFrameGridOptionsBaselineFrameGridOption readonlyBaseline frame grid option settings.
cellStyleGroupsCellStyleGroups CellStyleGroup readonlyA collection of cell style groups.
cellStylesCellStyles CellStyle readonlyA collection of cell styles.
changeGlyphPreferencesChangeGlyphPreference
NothingEnum
r/wChange glyph preferences. Can also accept: NothingEnum enumerator.
changeGrepPreferencesChangeGrepPreference
NothingEnum
r/wChange grep preferences. Can also accept: NothingEnum enumerator.
changeTextPreferencesChangeTextPreference
NothingEnum
r/wChange text preferences. Can also accept: NothingEnum enumerator.
changeTransliteratePreferencesChangeTransliteratePreference
NothingEnum
r/wChange transliterate preferences. Can also accept: NothingEnum enumerator.
characterStyleGroupsCharacterStyleGroups CharacterStyleGroup readonlyA collection of character style groups.
characterStylesCharacterStyles CharacterStyle readonlyA collection of character styles.
clipboardPreferencesClipboardPreference readonlyClipboard preference properties that define the way that the application interacts with the system clipboard.
colorsColors Color readonlyA collection of colors.
conditionSetsConditionSets ConditionSet readonlyA collection of condition sets for conditional text.
conditionalTextPreferencesConditionalTextPreference readonlyConditional text preferences.
conditionsConditions Condition readonlyA collection of conditions for conditional text.
dialogsDialogs Dialog readonlyA collection of dialogs.
dictionaryPreferencesDictionaryPreference readonlyUser dictionary preference settings.
documentPreferencesDocumentPreference readonlyDocument preference settings.
documentPresetsDocumentPresets DocumentPreset readonlyA collection of document presets.
documentsDocuments Document readonlyA collection of documents.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
excelImportPreferencesExcelImportPreference readonlyExcel import preferences.
exportForWebPreferencesExportForWebPreference readonlyThe default export for web preferences.
featureSetFeatureSetOptions:
FeatureSetOptions.ROMAN
FeatureSetOptions.JAPANESE
FeatureSetOptions.RIGHTTOLEFT
readonlyThe feature set.
filePathFile readonlyThe full path to the file.
findChangeGlyphOptionsFindChangeGlyphOption
NothingEnum
r/wFind/change glyph options. Can also accept: NothingEnum enumerator.
findChangeGrepOptionsFindChangeGrepOption
NothingEnum
r/wFind/change grep options. Can also accept: NothingEnum enumerator.
findChangeObjectOptionsFindChangeObjectOption
NothingEnum
r/wFind/change object options. Can also accept: NothingEnum enumerator.
findChangeTextOptionsFindChangeTextOption
NothingEnum
r/wFind/change text options. Can also accept: NothingEnum enumerator.
findChangeTransliterateOptionsFindChangeTransliterateOption
NothingEnum
r/wFind/change transliterate options. Can also accept: NothingEnum enumerator.
findGlyphPreferencesFindGlyphPreference
NothingEnum
r/wFind glyph preferences. Can also accept: NothingEnum enumerator.
findGrepPreferencesFindGrepPreference
NothingEnum
r/wFind grep preferences. Can also accept: NothingEnum enumerator.
findTextPreferencesFindTextPreference
NothingEnum
r/wFind text preferences. Can also accept: NothingEnum enumerator.
findTransliteratePreferencesFindTransliteratePreference
NothingEnum
r/wFind transliterate preferences. Can also accept: NothingEnum enumerator.
fontsFonts Font readonlyA collection of fonts.
footnoteOptionsFootnoteOption readonlyFootnote option settings.
frameFittingOptionsFrameFittingOption readonlyThe frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
fullNameFile readonlyThe full path to the Application, including the name of the Application.
galleyPDFExportPreferencesPDFGalleyExportPreference readonlyPDF galley export preference settings.
galleyPreferencesGalleyPreference readonlyGalley preference settings.
galleyPrintPreferencesGalleyPrintPreference readonlyGalley print preferences.
generalPreferencesGeneralPreference readonlyGeneral preference settings.
gradientsGradients Gradient readonlyA collection of gradients.
gridPreferencesGridPreference readonlyGrid preference settings.
guidePreferencesGuidePreference readonlyGuide preference settings.
idleTasksIdleTasks IdleTask readonlyAll attachable idle tasks.
imageIOPreferencesImageIOPreference readonlyThe image I/O preference properties that define preferences for importing images.
imagePreferencesImagePreference readonlyImage preferences.
imePreferencesIMEPreference readonlyIME preference settings.
importedPageAttributesImportedPageAttribute readonlyPlaced InDesign page attributes.
incopyExportOptionsInCopyExportOption readonlyExport options for InCopy INCX document format.
indexingSortOptionsIndexingSortOptions IndexingSortOption readonlyA collection of indexing sort options.
inksInks Ink readonlyA collection of inks.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
kinsokuTablesKinsokuTables KinsokuTable readonlyA collection of kinsoku tables.
labelstring r/wA property that can be set to any string.
languagesWithVendorsLanguagesWithVendors readonlyA collection of languages with vendors.
layoutPDFExportPreferencesPDFLayoutExportPreference readonlyPDF layout export preference settings.
layoutPrintPreferencesLayoutPrintPreference readonlyLayout print preferences.
linkingPreferencesLinkingPreference readonlyThe links preference properties that define preferences for links.
liveScreenDrawingLiveDrawingOptions:
LiveDrawingOptions.NEVER
LiveDrawingOptions.IMMEDIATELY
LiveDrawingOptions.DELAYED
r/wDelay before mouse operations trigger live screen drawing of page items.
localeLocale:
Locale.DANISH_LOCALE
Locale.ENGLISH_LOCALE
Locale.INTERNATIONAL_ENGLISH_LOCALE
Locale.FINNISH_LOCALE
Locale.FRENCH_LOCALE
Locale.GERMAN_LOCALE
Locale.ITALIAN_LOCALE
Locale.PORTUGUESE_LOCALE
Locale.SPANISH_LOCALE
Locale.SWEDISH_LOCALE
Locale.JAPANESE_LOCALE
Locale.ARABIC_LOCALE
Locale.CZECH_LOCALE
Locale.GREEK_LOCALE
Locale.HEBREW_LOCALE
Locale.HUNGARIAN_LOCALE
Locale.POLISH_LOCALE
Locale.ROMANIAN_LOCALE
Locale.RUSSIAN_LOCALE
Locale.TURKISH_LOCALE
Locale.UKRAINIAN_LOCALE
Locale.KOREAN_LOCALE
Locale.SIMPLIFIED_CHINESE_LOCALE
Locale.TRADITIONAL_CHINESE_LOCALE
readonlyThe locale of the application.
marginPreferencesMarginPreference readonlyMargin preference settings.
menuActionsMenuActions MenuAction readonlyA collection of menu actions.
menusMenus Menu readonlyA collection of menus.
mixedInkGroupsMixedInkGroups MixedInkGroup readonlyA collection of mixed ink groups.
mixedInksMixedInks MixedInk readonlyA collection of mixed inks.
modalStatebool readonlyIf true, a modal dialog or alert is active.
mojikumiTablesMojikumiTables MojikumiTable readonlyA collection of mojikumi tables.
mojikumiUIPreferencesMojikumiUiPreference readonlyMojikumi user interface preference settings.
namestring readonlyThe name of the Application.
notePreferencesNotePreference readonlyNote preference settings.
numberingListsNumberingLists NumberingList readonlyA collection of numbered lists.
pageItemDefaultsPageItemDefault readonlyThe default page item formatting for the Application.
panelsPanels Panel readonlyA collection of panels.
paragraphStyleGroupsParagraphStyleGroups ParagraphStyleGroup readonlyA collection of paragraph style groups.
paragraphStylesParagraphStyles ParagraphStyle readonlyA collection of paragraph styles.
parentApplication readonlyThe parent of the Application (a Application).
pasteboardPreferencesPasteboardPreference readonlyPasteboard preference settings.
performanceMetrics Array of number readonlyThe available performance metrics.
placeableFileExtensions Array of string readonlyLists the extensions of file types that can be placed.
placeableFileTypes Array of string readonlyLists the types of files that can be placed.
preferencesPreferences Preference readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
redoHistory Array of string readonlyThe names of the items in the redo stack.
redoNamestring readonlyThe name of the action on the top of the redo stack.
scriptArgsScriptArg readonlyArguments to pass to a script.
scriptMenuActionsScriptMenuActions ScriptMenuAction readonlyA collection of script menu actions.
scriptPreferencesScriptPreference readonlyScript preferences.
selection Array of Object r/wThe selected object(s). Can also accept: Object or NothingEnum enumerator.
serialNumberstring readonlyThe user's serial number.
spellPreferencesSpellPreference readonlySpell-check preferences.
storyPreferencesStoryPreference readonlyStory preference settings.
strokeFillProxySettingsStrokeFillProxySetting readonlyStroke/fill proxy settings.
strokeStylesStrokeStyles StrokeStyle readonlyA collection of stroke styles.
swatchesSwatches readonlyA collection of swatches.
tableStyleGroupsTableStyleGroups TableStyleGroup readonlyA collection of table style groups.
tableStylesTableStyles TableStyle readonlyA collection of table styles.
taggedTextExportPreferencesTaggedTextExportPreference readonlyTagged text export preferences.
taggedTextImportPreferencesTaggedTextImportPreference readonlyTagged text import preferences.
textDefaultsTextDefault readonlyText default settings.
textEditingPreferencesTextEditingPreference readonlyText editing preference settings.
textExportPreferencesTextExportPreference readonlyText export preferences.
textFramePreferencesTextFramePreference readonlyText frame preference settings.
textImportPreferencesTextImportPreference readonlyText import preferences.
textMacrosTextMacros TextMacro readonlyA collection of text macros.
textPreferencesTextPreference readonlyText preference settings.
textVariablesTextVariables TextVariable readonlyA collection of text variables.
textWrapPreferencesTextWrapPreference readonlyThe text wrap preference properties that define the default formatting for wrapping text around objects.
tintsTints Tint readonlyA collection of tints.
toolBoxToolsToolBox readonlyThe current tool box states
trackChangesPreferencesTrackChangesPreference readonlyTrack changes preference settings.
transformationMatricesTransformationMatrices readonlyA collection of transformation matrices.
trapPresetsTrapPresets TrapPreset readonlyA collection of trap presets.
undoHistory Array of string readonlyThe names of the items in the undo stack.
undoNamestring readonlyThe name of the action on the top of the undo stack.
unusedSwatches Array of Swatch readonlyThe swatches that are not being used.
userColor3 Reals (0 - 255)
InCopyUIColors
r/wThe color assigned to the tracked changes and notes created by the user, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
userDictionariesUserDictionaries UserDictionary readonlyA collection of user dictionaries.
userNamestring r/wThe user associated with the tracked changes and notes.
versionstring readonlyThe application version.
viewPreferencesViewPreference readonlyView preference settings.
visiblebool readonlyIf true, the Application is visible.
windowsWindows Window readonlyA collection of windows.
wordRTFImportPreferencesWordRTFImportPreference readonlyWord and RTF import preferences.
xmlExportMapsXMLExportMaps XMLExportMap readonlyA collection of XML export maps.
xmlExportPreferencesXMLExportPreference readonlyXML export preference settings.
xmlImportMapsXMLImportMaps XMLImportMap readonlyA collection of XML import maps.
xmlImportPreferencesXMLImportPreference readonlyXML import preference settings.
xmlPreferencesXMLPreference readonlyThe XML preference settings.
xmlTagsXMLTags XMLTag readonlyA collection of XML tags.
xmlViewPreferencesXMLViewPreference readonlyXML view preference settings.

Class

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

Methods

Instances

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

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

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

void applyMenuCustomization ([name: string])
Applies the specified menu customization set. An empty string will reset all menus and colorization (Show Full Menus). No string will apply the default menu set.

ParameterTypeDescription
namestringThe menu customization set. (Optional)

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

ParameterTypeDescription
namestringThe shortcut set. (Optional)

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

ParameterTypeDescription
namestringThe workspace. (Optional)

void cancelAllTasks ()
Cancels all the background tasks.

void cascadeWindows ()
Cascades all document windows.

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

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

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

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

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

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

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

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

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

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

void copy ()
Copies the selection in the active document window to the clipboard.

void cut ()
Cuts the selection in the active document window and stores it in the clipboard.

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

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

void deleteUnusedTags ()
Deletes unused XML markup tags.

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

ParameterTypeDescription
scriptFile
JavaScript Function
String
The script to execute. Can accept: File, String or JavaScript Function.
languageScriptLanguage:
ScriptLanguage.UNKNOWN
ScriptLanguage.JAVASCRIPT
ScriptLanguage.APPLESCRIPT_LANGUAGE
The language of the script to execute. If not specified, uses the language used to call this method. (Optional) (default: ScriptLanguage.UNKNOWN)
withArguments Array of any An array of arguments passed to the script. (Optional)
undoModeUndoModes:
UndoModes.SCRIPT_REQUEST
UndoModes.ENTIRE_SCRIPT
UndoModes.AUTO_UNDO
UndoModes.FAST_ENTIRE_SCRIPT
How to undo this script. (Optional) (default: UndoModes.SCRIPT_REQUEST)
undoNamestringThe name of the undo step for entire script undo mode. (Optional) (default: Script)

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

ParameterTypeDescription
fromnumberThe first mark in the range.
tonumberThe last mark in the range.

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

ParameterTypeDescription
fromnumberThe mark from which to dump memory.

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

ParameterTypeDescription
keystringThe key.

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

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

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

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

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

ParameterTypeDescription
forstringThe string to search for.

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

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

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

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

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

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

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

ParameterTypeDescription
toFileThe folder path of the schema.
packageFormatboolIf true, generate schema for package format (multiple files). Default value is false. (Optional)

Array of Application getElements ()
Resolves the object specifier, creating an array of object references.

Color importAdobeSwatchbookProcessColor (name: string)
Imports a process color swatch from a preloaded Adobe color book.

ParameterTypeDescription
namestringThe process color to load.

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

ParameterTypeDescription
namestringThe spot color to load.

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

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

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

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

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

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

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

ParameterTypeDescription
fromFileThe swatch file or InDesign document.

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

ParameterTypeDescription
fromFileThe path to the file that contains the tags.

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

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

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

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

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

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

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

void paste ()
Pastes data from the clipboard into the active document window.

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

void pasteInto ()
Pastes data from the clipboard into the selected object in the active document window.

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

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

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

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

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

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

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

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

ParameterTypeDescription
from Array of Files
File
One or more file paths. Can accept: File or Array of Files.
printDialogboolWhether to invoke the print dialog (Optional)

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

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

void redo ()
Redoes the last action.

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

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

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

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

void saveSwatches (to: File, swatchList: Array of Swatch[, versionComments: string][, forceSave: bool=false])
Saves the specified swatch(es) to a swatchbook file.

ParameterTypeDescription
toFileThe swatchbook file to save to.
swatchList Array of SwatchThe swatch(es) to save.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

void saveXMLTags (to: File[, versionComments: string][, forceSave: bool=false])
Saves a set of tags to an external file.

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

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

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

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

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

void tileWindows ()
Tile all document windows

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

string toSpecifier ()
Retrieves the object specifier.

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

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

ParameterTypeDescription
forstringThe key string to translate

void undo ()
Undoes the last action.

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

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

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

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

Element of

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, 29-Apr-2012 v3.0.3iContents :: Index