Packagecom.adobe.indesign
Classpublic class Application
InheritanceApplication Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  activeBook : Book
The active book.
Application
  activeDocument : Document
The front-most document.
Application
  activeScript : File
[read-only] The current script running from the Scripts panel.
Application
  activeScriptUndoMode : UndoModes
[read-only] The undo mode for the current script execution.
Application
  activeWindow : Object
The front-most window.
Application
  AFTER_ACTIVATE : String
[static] [read-only] Dispatched after the Application becomes active.
Application
  AFTER_CLOSE : String
[static] [read-only] Dispatched after a Document is closed.
Application
  AFTER_CONTEXT_CHANGED : String
[static] [read-only] Dispatched after the active context changes.
Application
  AFTER_QUIT : String
[static] [read-only] Dispatched when the Application is quitting.
Application
  AFTER_SELECTION_ATTRIBUTE_CHANGED : String
[static] [read-only] Dispatched after an attribute on the active selection changes.
Application
  AFTER_SELECTION_CHANGED : String
[static] [read-only] Dispatched after the active selection changes.
Application
  alignDistributePreferences : AlignDistributePreference
[read-only] Preferences for alignment and distribution.
Application
  allCellStyles : Object
[read-only] All Cell styles
Application
  allCharacterStyles : Object
[read-only] Lists all character styles (regardless of their group).
Application
  allObjectStyles : Object
[read-only] All object styles contained by the Application.
Application
  allParagraphStyles : Object
[read-only] Lists all paragraph styles (regardless of their group).
Application
  allPreflightObjectTypes : Object
[read-only] The list of all object types (strings) a preflight rule can operate on.
Application
  allPreflightRuleCategories : Object
[read-only] The list of all categories that have been declared by rules.
Application
  allPreflightRuleIDs : Object
[read-only] The list of all known (declared) rule IDs.
Application
  allTableStyles : Object
[read-only] All Table styles
Application
  anchoredObjectDefaults : AnchoredObjectDefault
[read-only] Anchored object default settings.
Application
  anchoredObjectSettings : AnchoredObjectSetting
[read-only] Anchored object settings.
Application
  autoCorrectPreferences : AutoCorrectPreference
[read-only] Auto-correct preferences.
Application
  autoCorrectTables : AutoCorrectTables
[read-only] A collection of auto-correct tables.
Application
  backgroundTasks : BackgroundTasks
[read-only] A collection of background task objects.
Application
  baselineFrameGridOptions : BaselineFrameGridOption
[read-only] Baseline frame grid option settings.
Application
  BEFORE_DEACTIVATE : String
[static] [read-only] Dispatched before the Application becomes inactive.
Application
  BEFORE_NEW : String
[static] [read-only] Dispatched before a Document is created.
Application
  BEFORE_OPEN : String
[static] [read-only] Dispatched before a Document is opened.
Application
  BEFORE_QUIT : String
[static] [read-only] Dispatched before the Application is quit.
Application
  books : Books
[read-only] A collection of books.
Application
  buttonPreferences : ButtonPreference
[read-only] Button preference settings.
Application
  cellStyleGroups : CellStyleGroups
[read-only] A collection of cell style groups.
Application
  cellStyles : CellStyles
[read-only] A collection of cell styles.
Application
  changeGlyphPreferences : ChangeGlyphPreference
Change glyph preferences.
Application
  changeGrepPreferences : ChangeGrepPreference
Change grep preferences.
Application
  changeObjectPreferences : ChangeObjectPreference
Change object preferences.
Application
  changeTextPreferences : ChangeTextPreference
Change text preferences.
Application
  changeTransliteratePreferences : ChangeTransliteratePreference
Change transliterate preferences.
Application
  characterStyleGroups : CharacterStyleGroups
[read-only] A collection of character style groups.
Application
  characterStyles : CharacterStyles
[read-only] A collection of character styles.
Application
  cjkGridPreferences : CjkGridPreference
[read-only] CJK grid preference settings.
Application
  clearOverridesWhenApplyingStyle : Boolean
Clear overrides first before applying object style
Application
  clipboardPreferences : ClipboardPreference
[read-only] Clipboard preference properties that define the way that the application interacts with the system clipboard.
Application
  colors : Colors
[read-only] A collection of colors.
Application
  colorSettings : ColorSetting
[read-only] Color setting properties that define color management defaults.
Application
  compositeFonts : CompositeFonts
[read-only] A collection of composite fonts.
Application
  conditionalTextPreferences : ConditionalTextPreference
[read-only] Conditional text preferences.
Application
  conditions : Conditions
[read-only] A collection of conditions for conditional text.
Application
  conditionSets : ConditionSets
[read-only] A collection of condition sets for conditional text.
Application
  dashedStrokeStyles : DashedStrokeStyles
[read-only] A collection of dashed stroke styles.
Application
  dataMergeOptions : DataMergeOption
[read-only] The data merge option properties that define the data merge.
Application
  dialogs : Dialogs
[read-only] A collection of dialogs.
Application
  dictionaryPreferences : DictionaryPreference
[read-only] User dictionary preference settings.
Application
  displayPerformancePreferences : DisplayPerformancePreference
[read-only] Display performance settings.
Application
  displaySettings : DisplaySettings
[read-only] Display setting properties.
Application
  documentPreferences : DocumentPreference
[read-only] Document preference settings.
Application
  documentPresets : DocumentPresets
[read-only] A collection of document presets.
Application
  documents : Documents
[read-only] A collection of documents.
Application
  dottedStrokeStyles : DottedStrokeStyles
[read-only] A collection of dotted stroke styles.
Application
  epsExportPreferences : EPSExportPreference
[read-only] EPS export preferences.
Application
  epsImportPreferences : EPSImportPreference
[read-only] EPS import preferences.
Application
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Application
  events : Events
[read-only] A collection of events.
Application
  excelImportPreferences : ExcelImportPreference
[read-only] Excel import preferences.
Application
  exportForWebPreferences : ExportForWebPreference
[read-only] The default export for web preferences.
Application
  featureSet : FeatureSetOptions
[read-only] The feature set.
Application
  filePath : File
[read-only] The full path to the file.
Application
  findChangeGlyphOptions : FindChangeGlyphOption
Find/change glyph options.
Application
  findChangeGrepOptions : FindChangeGrepOption
Find/change grep options.
Application
  findChangeObjectOptions : FindChangeObjectOption
Find/change object options.
Application
  findChangeTextOptions : FindChangeTextOption
Find/change text options.
Application
  findChangeTransliterateOptions : FindChangeTransliterateOption
Find/change transliterate options.
Application
  findGlyphPreferences : FindGlyphPreference
Find glyph preferences.
Application
  findGrepPreferences : FindGrepPreference
Find grep preferences.
Application
  findObjectPreferences : FindObjectPreference
Find object preferences.
Application
  findTextPreferences : FindTextPreference
Find text preferences.
Application
  findTransliteratePreferences : FindTransliteratePreference
Find transliterate preferences.
Application
  flattenerPresets : FlattenerPresets
[read-only] A collection of transparency flattener presets.
Application
  fonts : Fonts
[read-only] A collection of fonts.
Application
  footnoteOptions : FootnoteOption
[read-only] Footnote option settings.
Application
  frameFittingOptions : FrameFittingOption
[read-only] The frame fitting option to apply to placed or pasted content.
Application
  fullName : File
[read-only] The full path to the Application, including the name of the Application.
Application
  galleyPreferences : GalleyPreference
[read-only] Galley preference settings.
Application
  generalPreferences : GeneralPreference
[read-only] General preference settings.
Application
  grabberPreferences : GrabberPreference
[read-only] Grabber preference properties that define display performance quality during scrolling.
Application
  gradients : Gradients
[read-only] A collection of gradients.
Application
  gridPreferences : GridPreference
[read-only] Grid preference settings.
Application
  gridPrintingPreferences : GridPrintingPreference
[read-only] Grid printing preference and export settings.
Application
  guidePreferences : GuidePreference
[read-only] Guide preference settings.
Application
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  idleTasks : IdleTasks
[read-only] All attachable idle tasks.
Application
  imageIOPreferences : ImageIOPreference
[read-only] The image I/O preference properties that define preferences for importing images.
Application
  imagePreferences : ImagePreference
[read-only] Image preferences.
Application
  imePreferences : IMEPreference
[read-only] IME preference settings.
Application
  importedPageAttributes : ImportedPageAttribute
[read-only] Placed InDesign page attributes.
Application
  incopyExportOptions : InCopyExportOption
[read-only] Export options for InCopy INCX document format.
Application
  indexGenerationOptions : IndexOptions
[read-only] The index options properties that define how an index is formatted.
Application
  indexingSortOptions : IndexingSortOptions
[read-only] A collection of indexing sort options.
Application
  inks : Inks
[read-only] A collection of inks.
Application
  interactivePDFExportPreferences : InteractivePDFExportPreference
[read-only] Interactive PDF export preferences.
Application
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Application
  jpegExportPreferences : JPEGExportPreference
[read-only] JPEG export preferences.
Application
  kinsokuTables : KinsokuTables
[read-only] A collection of kinsoku tables.
Application
  label : String
A property that can be set to any string.
Application
  languagesWithVendors : LanguagesWithVendors
[read-only] A collection of languages with vendors.
Application
  layoutAdjustmentPreferences : LayoutAdjustmentPreference
[read-only] Layout sdjustment preference settings.
Application
  layoutGridData : LayoutGridDataInformation
[read-only] Default properties specific to layout grids.
Application
  layoutWindows : LayoutWindows
[read-only] A collection of layout windows.
Application
  libraries : Libraries
[read-only] A collection of object libraries.
Application
  linkingPreferences : LinkingPreference
[read-only] The links preference properties that define preferences for links.
Application
  liveScreenDrawing : LiveDrawingOptions
Delay before mouse operations trigger live screen drawing of page items.
Application
  locale : Locale
[read-only] The locale of the application.
Application
  marginPreferences : MarginPreference
[read-only] Margin preference settings.
Application
  menuActions : MenuActions
[read-only] A collection of menu actions.
Application
  menus : Menus
[read-only] A collection of menus.
Application
  mixedInkGroups : MixedInkGroups
[read-only] A collection of mixed ink groups.
Application
  mixedInks : MixedInks
[read-only] A collection of mixed inks.
Application
  modalState : Boolean
[read-only] If true, a modal dialog or alert is active.
Application
  mojikumiTables : MojikumiTables
[read-only] A collection of mojikumi tables.
Application
  mojikumiUIPreferences : MojikumiUiPreference
[read-only] Mojikumi user interface preference settings.
Application
  motionPresets : MotionPresets
[read-only] A collection of Motion presets.
Application
  name : String
[read-only] The name of the Application.
Application
  namedGrids : NamedGrids
[read-only] A collection of named grids.
Application
  notePreferences : NotePreference
[read-only] Note preference settings.
Application
  numberingLists : NumberingLists
[read-only] A collection of numbered lists.
Application
  objectStyleGroups : ObjectStyleGroups
[read-only] A collection of object style groups.
Application
  objectStyles : ObjectStyles
[read-only] A collection of object styles.
Application
  pageItemDefaults : PageItemDefault
[read-only] The default page item formatting for the Application.
Application
  panels : Panels
[read-only] A collection of panels.
Application
  paragraphStyleGroups : ParagraphStyleGroups
[read-only] A collection of paragraph style groups.
Application
  paragraphStyles : ParagraphStyles
[read-only] A collection of paragraph styles.
Application
  parent : Application
[read-only] The parent of the Application (a Application).
Application
  pasteboardPreferences : PasteboardPreference
[read-only] Pasteboard preference settings.
Application
  pdfExportPreferences : PDFExportPreference
[read-only] A collection of PDF export preferences.
Application
  pdfExportPresets : PDFExportPresets
[read-only] A collection of PDF export presets.
Application
  pdfPlacePreferences : PDFPlacePreference
[read-only] The PDF place preference properties that define how PDF files are placed in the current document.
Application
  performanceMetrics : Object
[read-only] The available performance metrics.
Application
  placeableFileExtensions : Object
[read-only] Lists the extensions of file types that can be placed.
Application
  placeableFileTypes : Object
[read-only] Lists the types of files that can be placed.
Application
  polygonPreferences : PolygonPreference
[read-only] Polygon preference properties to use to define default settings for creating a polygon.
Application
  preferences : Preferences
[read-only] A collection of preferences objects.
Application
  preflightBookOptions : PreflightBookOption
[read-only] Preflight book option settings.
Application
  preflightOptions : PreflightOption
[read-only] Preflight option settings.
Application
  preflightProcesses : PreflightProcesses
[read-only] A collection of preflight processes.
Application
  preflightProfiles : PreflightProfiles
[read-only] A collection of preflight profiles.
Application
  preflightRules : PreflightRules
[read-only] A collection of preflight rules.
Application
  printerPresets : PrinterPresets
[read-only] A collection of printer presets.
Application
  properties : Object
A property that allows setting of several properties at the same time.
Application
  redoHistory : Object
[read-only] The names of the items in the redo stack.
Application
  redoName : String
[read-only] The name of the action on the top of the redo stack.
Application
  scriptArgs : ScriptArg
[read-only] Arguments to pass to a script.
Application
  scriptMenuActions : ScriptMenuActions
[read-only] A collection of script menu actions.
Application
  scriptPreferences : ScriptPreference
[read-only] Script preferences.
Application
  selection : Object
The selected object(s).
Application
  serialNumber : String
[read-only] The user's serial number.
Application
  smartGuidePreferences : SmartGuidePreference
[read-only] Smart Guide preference properties.
Application
  spellPreferences : SpellPreference
[read-only] Spell-check preferences.
Application
  storyGridData : StoryGridDataInformation
[read-only] Default properties specific to frame grids.
Application
  storyPreferences : StoryPreference
[read-only] Story preference settings.
Application
  storyWindows : StoryWindows
[read-only] A collection of story windows.
Application
  stripedStrokeStyles : StripedStrokeStyles
[read-only] A collection of striped stroke styles.
Application
  strokeFillProxySettings : StrokeFillProxySetting
[read-only] Stroke/fill proxy settings.
Application
  strokeStyles : StrokeStyles
[read-only] A collection of stroke styles.
Application
  swatches : Swatches
[read-only] A collection of swatches.
Application
  swfExportPreferences : SWFExportPreference
[read-only] SWF export preferences.
Application
  tableStyleGroups : TableStyleGroups
[read-only] A collection of table style groups.
Application
  tableStyles : TableStyles
[read-only] A collection of table styles.
Application
  taggedTextExportPreferences : TaggedTextExportPreference
[read-only] Tagged text export preferences.
Application
  taggedTextImportPreferences : TaggedTextImportPreference
[read-only] Tagged text import preferences.
Application
  textDefaults : TextDefault
[read-only] Text default settings.
Application
  textEditingPreferences : TextEditingPreference
[read-only] Text editing preference settings.
Application
  textExportPreferences : TextExportPreference
[read-only] Text export preferences.
Application
  textFramePreferences : TextFramePreference
[read-only] Text frame preference settings.
Application
  textImportPreferences : TextImportPreference
[read-only] Text import preferences.
Application
  textPreferences : TextPreference
[read-only] Text preference settings.
Application
  textVariables : TextVariables
[read-only] A collection of text variables.
Application
  textWrapPreferences : TextWrapPreference
[read-only] The text wrap preference properties that define the default formatting for wrapping text around objects.
Application
  tints : Tints
[read-only] A collection of tints.
Application
  toolBoxTools : ToolBox
[read-only] The current tool box states
Application
  trackChangesPreferences : TrackChangesPreference
[read-only] Track changes preference settings.
Application
  transformationMatrices : TransformationMatrices
[read-only] A collection of transformation matrices.
Application
  transformPreferences : TransformPreference
[read-only] Transform preference properties that define default behaviors when transforming objects.
Application
  transparencyPreferences : TransparencyPreference
[read-only] Transparency preference settings.
Application
  trapPresets : TrapPresets
[read-only] A collection of trap presets.
Application
  undoHistory : Object
[read-only] The names of the items in the undo stack.
Application
  undoName : String
[read-only] The name of the action on the top of the undo stack.
Application
  unusedSwatches : Object
[read-only] The swatches that are not being used.
Application
  userColor : Object
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.
Application
  userDictionaries : UserDictionaries
[read-only] A collection of user dictionaries.
Application
  userName : String
The user associated with the tracked changes and notes.
Application
  version : String
[read-only] The application version.
Application
  viewPreferences : ViewPreference
[read-only] View preference settings.
Application
  visible : Boolean
[read-only] If true, the Application is visible.
Application
  watermarkPreferences : WatermarkPreference
[read-only] Watermark preferences
Application
  windows : Windows
[read-only] A collection of windows.
Application
  wordRTFImportPreferences : WordRTFImportPreference
[read-only] Word and RTF import preferences.
Application
  xflExportPreferences : XFLExportPreference
[read-only] XFL export preferences.
Application
  xmlExportMaps : XMLExportMaps
[read-only] A collection of XML export maps.
Application
  xmlExportPreferences : XMLExportPreference
[read-only] XML export preference settings.
Application
  xmlImportMaps : XMLImportMaps
[read-only] A collection of XML import maps.
Application
  xmlImportPreferences : XMLImportPreference
[read-only] XML import preference settings.
Application
  xmlPreferences : XMLPreference
[read-only] The XML preference settings.
Application
  xmlRuleProcessors : XMLRuleProcessors
[read-only] A collection of XML rule processors.
Application
  xmlTags : XMLTags
[read-only] A collection of XML tags.
Application
  xmlViewPreferences : XMLViewPreference
[read-only] XML view preference settings.
Application
Public Methods
 MethodDefined By
  
activate():void
Makes the application the front-most or active window.
Application
  
addEventListenerApplication(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Application
  
applyMenuCustomization(nameParam:String = null):void
Applies the specified menu customization set.
Application
  
applyShortcutSet(nameParam:String = null):void
Applies the specified shortcut set file.
Application
  
applyWorkspace(nameParam:String = null):void
Applies the specified workspace.
Application
  
Cancels all the background tasks.
Application
  
Cascades all document windows.
Application
  
changeGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Application
  
changeGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value.
Application
  
changeObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value and replace the objects with the change to value.
Application
  
changeText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value.
Application
  
changeTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value and replaces the text with the change character type value.
Application
  
Removes the frame fittings options and resets it to the initial state.
Application
  
copy():void
Copies the selection in the active document window to the clipboard.
Application
  
cut():void
Cuts the selection in the active document window and stores it in the clipboard.
Application
  
deleteFindChangeQuery(queryNameParam:String = null, searchModeParam:SearchModes = null):void
Deletes the specified find/change query.
Application
  
Deletes unused XML markup tags.
Application
  
dommygeneratecode(dommytemplateinputfolderParam:String = null, dommycodeoutputfolderParam:String = null):void
Generate Code Via DommyDumper
Application
  
doScript(scriptParam:Object = null, languageParam:ScriptLanguage = null, withArgumentsParam:Array = null, undoModeParam:UndoModes = null, undoNameParam:String = Script):Object
Executes the script in the specified language as a single transaction.
Application
  
dumpBetweenMemoryMarks(fromParam:Number, toParam:Number):void
Dumps memory allocations from all marks in the specified range.
Application
  
dumpFromMemoryMark(fromParam:Number):void
Dumps memory allocations from the specified mark.
Application
  
exportPresets(formatParam:ExportPresetFormat = null, toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Export the presets to a file.
Application
  
exportStrokeStyles(toParam:File = null, strokeStyleListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports stroke styles or presets.
Application
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Application
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
findGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value.
Application
  
findGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value.
Application
  
findKeyStrings(forParam:String = null):Object
Returns the locale-independent string(s) from the internal string localization database that correspond to the specified string (in the current locale).
Application
  
findObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value.
Application
  
findText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value.
Application
  
findTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value.
Application
  
generateIDMLSchema(toParam:File = null, packageFormatParam:Boolean):void
Generate schema for IDML.
Application
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
Gets the instance ids of all open documents.
Application
  
getElements():Object
Resolves the object specifier, creating an array of object references.
Application
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
importAdobeSwatchbookProcessColor(nameParam:String = null):Color
Imports a process color swatch from a preloaded Adobe color book.
Application
  
importAdobeSwatchbookSpotColor(nameParam:String = null):Color
Imports a spot color swatch from an Adobe color book.
Application
  
importFile(formatParam:ExportPresetFormat = null, fromParam:File = null):void
Imports presets from the specified file.
Application
  
importStyles(formatParam:ImportFormat = null, fromParam:File = null, globalStrategyParam:GlobalClashResolutionStrategy = null):void
Imports the specified styles.
Application
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Application
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
jumpToComment(documentidParam:String = null, commentdataParam:String = null):void
Jump to the specified comment in open document.
Application
  
loadConditions(fromParam:File = null, loadConditionSetsParam:Boolean):void
Load conditions from the specified file.
Application
  
loadFindChangeQuery(queryNameParam:String = null, searchModeParam:SearchModes = null):void
Loads the specified find/change query.
Application
  
loadMotionPreset(fromParam:File = null):MotionPreset
Load motion preset from the specified file.
Application
  
loadPreflightProfile(fromParam:File = null):PreflightProfile
Load preflight profile from the specified file.
Application
  
loadSwatches(fromParam:File = null):void
Load swatches from the specified file.
Application
  
loadXMLTags(fromParam:File = null):void
Loads a set of XML markup tags from the specified file.
Application
  
Gets the memory statistics from the server.
Application
  
mountProject(serverURLParam:String = null, projectNameParam:String = null):void
Mount a Version Cue project.
Application
  
open(fromParam:Object = null, showingWindowParam:Boolean = true, openOptionParam:OpenOptions = null):Object
Opens the specified document, book, or library.
Application
  
packageUCF(sourceFolderParam:File = null, ucfFileParam:File = null, mimeMediaTypeParam:String = application/vnd.adobe.indesign-idml-package):void
Package a folder into a UCF file.
Application
  
paste():void
Pastes data from the clipboard into the active document window.
Application
  
Pastes data from the clipboard into the active document window at the same position that the data held in its original document.
Application
  
pasteInto():void
Pastes data from the clipboard into the selected object in the active document window.
Application
  
Pastes data (minus formatting) from the clipboard into the active document window.
Application
  
performanceMetric(forParam:Object = null):Object
Gets the current value of the specified performance metric.
Application
  
performanceMetricLongName(forParam:Object = null):String
Gets the long name of the specified performance metric.
Application
  
performanceMetricShortName(forParam:Object = null):String
Gets the short name of the specified performance metric.
Application
  
place(fileNameParam:Object = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):void
Place one or more files following the behavior of the place menu item.
Application
  
print(fromParam:Object = null, printDialogParam:Boolean, usingParam:Object = null):void
Prints the specified file(s).
Application
  
quit(savingParam:SaveOptions = null):void
Quits the application.
Application
  
redo():void
Redoes the last action.
Application
  
removeEventListenerApplication(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Application
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
saveFindChangeQuery(queryNameParam:String = null, searchModeParam:SearchModes = null):void
Saves the specified find/change query.
Application
  
saveSwatches(toParam:File = null, swatchListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves the specified swatch(es) to a swatchbook file.
Application
  
saveXMLTags(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves a set of tags to an external file.
Application
  
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Selects the specified object(s).
Application
  
setApplicationPreferences(applicationPreferencesParam:Object = null):void
Sets the application's preferences.
Application
  
Tile all document windows
Application
  
Toggles the visibility of the entire panel system.
Application
  
toSpecifier():String
Retrieves the object specifier.
Application
  
translateKeyString(forParam:String = null):String
Translates a key string into localized form based on current application locale.
Application
  
undo():void
Undoes the last action.
Application
  
unpackageUCF(ucfFileParam:File = null, destinationFolderParam:File = null):void
Unpackage a UCF file into a folder structure.
Application
  
updateBuzzwordLinkInfo(docIdParam:String = null, statusParam:LinkStatus = null, statusInfoParam:String = null, titleParam:String = null, docVersionParam:String = null, contentVersionParam:String = null, modYearParam:Number, modMonthParam:Number, modDayParam:Number, modHourParam:Number, modMinuteParam:Number, modSecondParam:Number):String
Update the link resource info of buzzword link.
Application
  
Forces a check for new fonts in the various Fonts folders.
Application
  
Waits for all the background tasks to finish.
Application
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
activeBookproperty
activeBook:Book

The active book.


Implementation
    public function get activeBook():Book
    public function set activeBook(value:Book):void
activeDocumentproperty 
activeDocument:Document

The front-most document.


Implementation
    public function get activeDocument():Document
    public function set activeDocument(value:Document):void
activeScriptproperty 
activeScript:File  [read-only]

The current script running from the Scripts panel.


Implementation
    public function get activeScript():File
activeScriptUndoModeproperty 
activeScriptUndoMode:UndoModes  [read-only]

The undo mode for the current script execution.


Implementation
    public function get activeScriptUndoMode():UndoModes
activeWindowproperty 
activeWindow:Object

The front-most window. Can return: Window, LayoutWindow or StoryWindow.


Implementation
    public function get activeWindow():Object
    public function set activeWindow(value:Object):void
AFTER_ACTIVATEproperty 
AFTER_ACTIVATE:String  [read-only]

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


Implementation
    public static function get AFTER_ACTIVATE():String
AFTER_CLOSEproperty 
AFTER_CLOSE:String  [read-only]

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


Implementation
    public static function get AFTER_CLOSE():String
AFTER_CONTEXT_CHANGEDproperty 
AFTER_CONTEXT_CHANGED:String  [read-only]

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


Implementation
    public static function get AFTER_CONTEXT_CHANGED():String
AFTER_QUITproperty 
AFTER_QUIT:String  [read-only]

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.


Implementation
    public static function get AFTER_QUIT():String
AFTER_SELECTION_ATTRIBUTE_CHANGEDproperty 
AFTER_SELECTION_ATTRIBUTE_CHANGED:String  [read-only]

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


Implementation
    public static function get AFTER_SELECTION_ATTRIBUTE_CHANGED():String
AFTER_SELECTION_CHANGEDproperty 
AFTER_SELECTION_CHANGED:String  [read-only]

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


Implementation
    public static function get AFTER_SELECTION_CHANGED():String
alignDistributePreferencesproperty 
alignDistributePreferences:AlignDistributePreference  [read-only]

Preferences for alignment and distribution.


Implementation
    public function get alignDistributePreferences():AlignDistributePreference
allCellStylesproperty 
allCellStyles:Object  [read-only]

All Cell styles


Implementation
    public function get allCellStyles():Object
allCharacterStylesproperty 
allCharacterStyles:Object  [read-only]

Lists all character styles (regardless of their group).


Implementation
    public function get allCharacterStyles():Object
allObjectStylesproperty 
allObjectStyles:Object  [read-only]

All object styles contained by the Application.


Implementation
    public function get allObjectStyles():Object
allParagraphStylesproperty 
allParagraphStyles:Object  [read-only]

Lists all paragraph styles (regardless of their group).


Implementation
    public function get allParagraphStyles():Object
allPreflightObjectTypesproperty 
allPreflightObjectTypes:Object  [read-only]

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


Implementation
    public function get allPreflightObjectTypes():Object
allPreflightRuleCategoriesproperty 
allPreflightRuleCategories:Object  [read-only]

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


Implementation
    public function get allPreflightRuleCategories():Object
allPreflightRuleIDsproperty 
allPreflightRuleIDs:Object  [read-only]

The list of all known (declared) rule IDs.


Implementation
    public function get allPreflightRuleIDs():Object
allTableStylesproperty 
allTableStyles:Object  [read-only]

All Table styles


Implementation
    public function get allTableStyles():Object
anchoredObjectDefaultsproperty 
anchoredObjectDefaults:AnchoredObjectDefault  [read-only]

Anchored object default settings.


Implementation
    public function get anchoredObjectDefaults():AnchoredObjectDefault
anchoredObjectSettingsproperty 
anchoredObjectSettings:AnchoredObjectSetting  [read-only]

Anchored object settings.


Implementation
    public function get anchoredObjectSettings():AnchoredObjectSetting
autoCorrectPreferencesproperty 
autoCorrectPreferences:AutoCorrectPreference  [read-only]

Auto-correct preferences.


Implementation
    public function get autoCorrectPreferences():AutoCorrectPreference
autoCorrectTablesproperty 
autoCorrectTables:AutoCorrectTables  [read-only]

A collection of auto-correct tables.


Implementation
    public function get autoCorrectTables():AutoCorrectTables
backgroundTasksproperty 
backgroundTasks:BackgroundTasks  [read-only]

A collection of background task objects.


Implementation
    public function get backgroundTasks():BackgroundTasks
baselineFrameGridOptionsproperty 
baselineFrameGridOptions:BaselineFrameGridOption  [read-only]

Baseline frame grid option settings.


Implementation
    public function get baselineFrameGridOptions():BaselineFrameGridOption
BEFORE_DEACTIVATEproperty 
BEFORE_DEACTIVATE:String  [read-only]

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


Implementation
    public static function get BEFORE_DEACTIVATE():String
BEFORE_NEWproperty 
BEFORE_NEW:String  [read-only]

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


Implementation
    public static function get BEFORE_NEW():String
BEFORE_OPENproperty 
BEFORE_OPEN:String  [read-only]

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


Implementation
    public static function get BEFORE_OPEN():String
BEFORE_QUITproperty 
BEFORE_QUIT:String  [read-only]

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


Implementation
    public static function get BEFORE_QUIT():String
booksproperty 
books:Books  [read-only]

A collection of books.


Implementation
    public function get books():Books
buttonPreferencesproperty 
buttonPreferences:ButtonPreference  [read-only]

Button preference settings.


Implementation
    public function get buttonPreferences():ButtonPreference
cellStyleGroupsproperty 
cellStyleGroups:CellStyleGroups  [read-only]

A collection of cell style groups.


Implementation
    public function get cellStyleGroups():CellStyleGroups
cellStylesproperty 
cellStyles:CellStyles  [read-only]

A collection of cell styles.


Implementation
    public function get cellStyles():CellStyles
changeGlyphPreferencesproperty 
changeGlyphPreferences:ChangeGlyphPreference

Change glyph preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get changeGlyphPreferences():ChangeGlyphPreference
    public function set changeGlyphPreferences(value:ChangeGlyphPreference):void
changeGrepPreferencesproperty 
changeGrepPreferences:ChangeGrepPreference

Change grep preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get changeGrepPreferences():ChangeGrepPreference
    public function set changeGrepPreferences(value:ChangeGrepPreference):void
changeObjectPreferencesproperty 
changeObjectPreferences:ChangeObjectPreference

Change object preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get changeObjectPreferences():ChangeObjectPreference
    public function set changeObjectPreferences(value:ChangeObjectPreference):void
changeTextPreferencesproperty 
changeTextPreferences:ChangeTextPreference

Change text preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get changeTextPreferences():ChangeTextPreference
    public function set changeTextPreferences(value:ChangeTextPreference):void
changeTransliteratePreferencesproperty 
changeTransliteratePreferences:ChangeTransliteratePreference

Change transliterate preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get changeTransliteratePreferences():ChangeTransliteratePreference
    public function set changeTransliteratePreferences(value:ChangeTransliteratePreference):void
characterStyleGroupsproperty 
characterStyleGroups:CharacterStyleGroups  [read-only]

A collection of character style groups.


Implementation
    public function get characterStyleGroups():CharacterStyleGroups
characterStylesproperty 
characterStyles:CharacterStyles  [read-only]

A collection of character styles.


Implementation
    public function get characterStyles():CharacterStyles
cjkGridPreferencesproperty 
cjkGridPreferences:CjkGridPreference  [read-only]

CJK grid preference settings.


Implementation
    public function get cjkGridPreferences():CjkGridPreference
clearOverridesWhenApplyingStyleproperty 
clearOverridesWhenApplyingStyle:Boolean

Clear overrides first before applying object style


Implementation
    public function get clearOverridesWhenApplyingStyle():Boolean
    public function set clearOverridesWhenApplyingStyle(value:Boolean):void
clipboardPreferencesproperty 
clipboardPreferences:ClipboardPreference  [read-only]

Clipboard preference properties that define the way that the application interacts with the system clipboard.


Implementation
    public function get clipboardPreferences():ClipboardPreference
colorsproperty 
colors:Colors  [read-only]

A collection of colors.


Implementation
    public function get colors():Colors
colorSettingsproperty 
colorSettings:ColorSetting  [read-only]

Color setting properties that define color management defaults.


Implementation
    public function get colorSettings():ColorSetting
compositeFontsproperty 
compositeFonts:CompositeFonts  [read-only]

A collection of composite fonts.


Implementation
    public function get compositeFonts():CompositeFonts
conditionalTextPreferencesproperty 
conditionalTextPreferences:ConditionalTextPreference  [read-only]

Conditional text preferences.


Implementation
    public function get conditionalTextPreferences():ConditionalTextPreference
conditionsproperty 
conditions:Conditions  [read-only]

A collection of conditions for conditional text.


Implementation
    public function get conditions():Conditions
conditionSetsproperty 
conditionSets:ConditionSets  [read-only]

A collection of condition sets for conditional text.


Implementation
    public function get conditionSets():ConditionSets
dashedStrokeStylesproperty 
dashedStrokeStyles:DashedStrokeStyles  [read-only]

A collection of dashed stroke styles.


Implementation
    public function get dashedStrokeStyles():DashedStrokeStyles
dataMergeOptionsproperty 
dataMergeOptions:DataMergeOption  [read-only]

The data merge option properties that define the data merge.


Implementation
    public function get dataMergeOptions():DataMergeOption
dialogsproperty 
dialogs:Dialogs  [read-only]

A collection of dialogs.


Implementation
    public function get dialogs():Dialogs
dictionaryPreferencesproperty 
dictionaryPreferences:DictionaryPreference  [read-only]

User dictionary preference settings.


Implementation
    public function get dictionaryPreferences():DictionaryPreference
displayPerformancePreferencesproperty 
displayPerformancePreferences:DisplayPerformancePreference  [read-only]

Display performance settings.


Implementation
    public function get displayPerformancePreferences():DisplayPerformancePreference
displaySettingsproperty 
displaySettings:DisplaySettings  [read-only]

Display setting properties.


Implementation
    public function get displaySettings():DisplaySettings
documentPreferencesproperty 
documentPreferences:DocumentPreference  [read-only]

Document preference settings.


Implementation
    public function get documentPreferences():DocumentPreference
documentPresetsproperty 
documentPresets:DocumentPresets  [read-only]

A collection of document presets.


Implementation
    public function get documentPresets():DocumentPresets
documentsproperty 
documents:Documents  [read-only]

A collection of documents.


Implementation
    public function get documents():Documents
dottedStrokeStylesproperty 
dottedStrokeStyles:DottedStrokeStyles  [read-only]

A collection of dotted stroke styles.


Implementation
    public function get dottedStrokeStyles():DottedStrokeStyles
epsExportPreferencesproperty 
epsExportPreferences:EPSExportPreference  [read-only]

EPS export preferences.


Implementation
    public function get epsExportPreferences():EPSExportPreference
epsImportPreferencesproperty 
epsImportPreferences:EPSImportPreference  [read-only]

EPS import preferences.


Implementation
    public function get epsImportPreferences():EPSImportPreference
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
excelImportPreferencesproperty 
excelImportPreferences:ExcelImportPreference  [read-only]

Excel import preferences.


Implementation
    public function get excelImportPreferences():ExcelImportPreference
exportForWebPreferencesproperty 
exportForWebPreferences:ExportForWebPreference  [read-only]

The default export for web preferences.


Implementation
    public function get exportForWebPreferences():ExportForWebPreference
featureSetproperty 
featureSet:FeatureSetOptions  [read-only]

The feature set.


Implementation
    public function get featureSet():FeatureSetOptions
filePathproperty 
filePath:File  [read-only]

The full path to the file.


Implementation
    public function get filePath():File
findChangeGlyphOptionsproperty 
findChangeGlyphOptions:FindChangeGlyphOption

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


Implementation
    public function get findChangeGlyphOptions():FindChangeGlyphOption
    public function set findChangeGlyphOptions(value:FindChangeGlyphOption):void
findChangeGrepOptionsproperty 
findChangeGrepOptions:FindChangeGrepOption

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


Implementation
    public function get findChangeGrepOptions():FindChangeGrepOption
    public function set findChangeGrepOptions(value:FindChangeGrepOption):void
findChangeObjectOptionsproperty 
findChangeObjectOptions:FindChangeObjectOption

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


Implementation
    public function get findChangeObjectOptions():FindChangeObjectOption
    public function set findChangeObjectOptions(value:FindChangeObjectOption):void
findChangeTextOptionsproperty 
findChangeTextOptions:FindChangeTextOption

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


Implementation
    public function get findChangeTextOptions():FindChangeTextOption
    public function set findChangeTextOptions(value:FindChangeTextOption):void
findChangeTransliterateOptionsproperty 
findChangeTransliterateOptions:FindChangeTransliterateOption

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


Implementation
    public function get findChangeTransliterateOptions():FindChangeTransliterateOption
    public function set findChangeTransliterateOptions(value:FindChangeTransliterateOption):void
findGlyphPreferencesproperty 
findGlyphPreferences:FindGlyphPreference

Find glyph preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get findGlyphPreferences():FindGlyphPreference
    public function set findGlyphPreferences(value:FindGlyphPreference):void
findGrepPreferencesproperty 
findGrepPreferences:FindGrepPreference

Find grep preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get findGrepPreferences():FindGrepPreference
    public function set findGrepPreferences(value:FindGrepPreference):void
findObjectPreferencesproperty 
findObjectPreferences:FindObjectPreference

Find object preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get findObjectPreferences():FindObjectPreference
    public function set findObjectPreferences(value:FindObjectPreference):void
findTextPreferencesproperty 
findTextPreferences:FindTextPreference

Find text preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get findTextPreferences():FindTextPreference
    public function set findTextPreferences(value:FindTextPreference):void
findTransliteratePreferencesproperty 
findTransliteratePreferences:FindTransliteratePreference

Find transliterate preferences. Can also accept: NothingEnum enumerator.


Implementation
    public function get findTransliteratePreferences():FindTransliteratePreference
    public function set findTransliteratePreferences(value:FindTransliteratePreference):void
flattenerPresetsproperty 
flattenerPresets:FlattenerPresets  [read-only]

A collection of transparency flattener presets.


Implementation
    public function get flattenerPresets():FlattenerPresets
fontsproperty 
fonts:Fonts  [read-only]

A collection of fonts.


Implementation
    public function get fonts():Fonts
footnoteOptionsproperty 
footnoteOptions:FootnoteOption  [read-only]

Footnote option settings.


Implementation
    public function get footnoteOptions():FootnoteOption
frameFittingOptionsproperty 
frameFittingOptions:FrameFittingOption  [read-only]

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.


Implementation
    public function get frameFittingOptions():FrameFittingOption
fullNameproperty 
fullName:File  [read-only]

The full path to the Application, including the name of the Application.


Implementation
    public function get fullName():File
galleyPreferencesproperty 
galleyPreferences:GalleyPreference  [read-only]

Galley preference settings.


Implementation
    public function get galleyPreferences():GalleyPreference
generalPreferencesproperty 
generalPreferences:GeneralPreference  [read-only]

General preference settings.


Implementation
    public function get generalPreferences():GeneralPreference
grabberPreferencesproperty 
grabberPreferences:GrabberPreference  [read-only]

Grabber preference properties that define display performance quality during scrolling.


Implementation
    public function get grabberPreferences():GrabberPreference
gradientsproperty 
gradients:Gradients  [read-only]

A collection of gradients.


Implementation
    public function get gradients():Gradients
gridPreferencesproperty 
gridPreferences:GridPreference  [read-only]

Grid preference settings.


Implementation
    public function get gridPreferences():GridPreference
gridPrintingPreferencesproperty 
gridPrintingPreferences:GridPrintingPreference  [read-only]

Grid printing preference and export settings.


Implementation
    public function get gridPrintingPreferences():GridPrintingPreference
guidePreferencesproperty 
guidePreferences:GuidePreference  [read-only]

Guide preference settings.


Implementation
    public function get guidePreferences():GuidePreference
idleTasksproperty 
idleTasks:IdleTasks  [read-only]

All attachable idle tasks.


Implementation
    public function get idleTasks():IdleTasks
imageIOPreferencesproperty 
imageIOPreferences:ImageIOPreference  [read-only]

The image I/O preference properties that define preferences for importing images.


Implementation
    public function get imageIOPreferences():ImageIOPreference
imagePreferencesproperty 
imagePreferences:ImagePreference  [read-only]

Image preferences.


Implementation
    public function get imagePreferences():ImagePreference
imePreferencesproperty 
imePreferences:IMEPreference  [read-only]

IME preference settings.


Implementation
    public function get imePreferences():IMEPreference
importedPageAttributesproperty 
importedPageAttributes:ImportedPageAttribute  [read-only]

Placed InDesign page attributes.


Implementation
    public function get importedPageAttributes():ImportedPageAttribute
incopyExportOptionsproperty 
incopyExportOptions:InCopyExportOption  [read-only]

Export options for InCopy INCX document format.


Implementation
    public function get incopyExportOptions():InCopyExportOption
indexGenerationOptionsproperty 
indexGenerationOptions:IndexOptions  [read-only]

The index options properties that define how an index is formatted.


Implementation
    public function get indexGenerationOptions():IndexOptions
indexingSortOptionsproperty 
indexingSortOptions:IndexingSortOptions  [read-only]

A collection of indexing sort options.


Implementation
    public function get indexingSortOptions():IndexingSortOptions
inksproperty 
inks:Inks  [read-only]

A collection of inks.


Implementation
    public function get inks():Inks
interactivePDFExportPreferencesproperty 
interactivePDFExportPreferences:InteractivePDFExportPreference  [read-only]

Interactive PDF export preferences.


Implementation
    public function get interactivePDFExportPreferences():InteractivePDFExportPreference
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
jpegExportPreferencesproperty 
jpegExportPreferences:JPEGExportPreference  [read-only]

JPEG export preferences.


Implementation
    public function get jpegExportPreferences():JPEGExportPreference
kinsokuTablesproperty 
kinsokuTables:KinsokuTables  [read-only]

A collection of kinsoku tables.


Implementation
    public function get kinsokuTables():KinsokuTables
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
languagesWithVendorsproperty 
languagesWithVendors:LanguagesWithVendors  [read-only]

A collection of languages with vendors.


Implementation
    public function get languagesWithVendors():LanguagesWithVendors
layoutAdjustmentPreferencesproperty 
layoutAdjustmentPreferences:LayoutAdjustmentPreference  [read-only]

Layout sdjustment preference settings.


Implementation
    public function get layoutAdjustmentPreferences():LayoutAdjustmentPreference
layoutGridDataproperty 
layoutGridData:LayoutGridDataInformation  [read-only]

Default properties specific to layout grids.


Implementation
    public function get layoutGridData():LayoutGridDataInformation
layoutWindowsproperty 
layoutWindows:LayoutWindows  [read-only]

A collection of layout windows.


Implementation
    public function get layoutWindows():LayoutWindows
librariesproperty 
libraries:Libraries  [read-only]

A collection of object libraries.


Implementation
    public function get libraries():Libraries
linkingPreferencesproperty 
linkingPreferences:LinkingPreference  [read-only]

The links preference properties that define preferences for links.


Implementation
    public function get linkingPreferences():LinkingPreference
liveScreenDrawingproperty 
liveScreenDrawing:LiveDrawingOptions

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


Implementation
    public function get liveScreenDrawing():LiveDrawingOptions
    public function set liveScreenDrawing(value:LiveDrawingOptions):void
localeproperty 
locale:Locale  [read-only]

The locale of the application.


Implementation
    public function get locale():Locale
marginPreferencesproperty 
marginPreferences:MarginPreference  [read-only]

Margin preference settings.


Implementation
    public function get marginPreferences():MarginPreference
menuActionsproperty 
menuActions:MenuActions  [read-only]

A collection of menu actions.


Implementation
    public function get menuActions():MenuActions
menusproperty 
menus:Menus  [read-only]

A collection of menus.


Implementation
    public function get menus():Menus
mixedInkGroupsproperty 
mixedInkGroups:MixedInkGroups  [read-only]

A collection of mixed ink groups.


Implementation
    public function get mixedInkGroups():MixedInkGroups
mixedInksproperty 
mixedInks:MixedInks  [read-only]

A collection of mixed inks.


Implementation
    public function get mixedInks():MixedInks
modalStateproperty 
modalState:Boolean  [read-only]

If true, a modal dialog or alert is active.


Implementation
    public function get modalState():Boolean
mojikumiTablesproperty 
mojikumiTables:MojikumiTables  [read-only]

A collection of mojikumi tables.


Implementation
    public function get mojikumiTables():MojikumiTables
mojikumiUIPreferencesproperty 
mojikumiUIPreferences:MojikumiUiPreference  [read-only]

Mojikumi user interface preference settings.


Implementation
    public function get mojikumiUIPreferences():MojikumiUiPreference
motionPresetsproperty 
motionPresets:MotionPresets  [read-only]

A collection of Motion presets.


Implementation
    public function get motionPresets():MotionPresets
nameproperty 
name:String  [read-only]

The name of the Application.


Implementation
    public function get name():String
namedGridsproperty 
namedGrids:NamedGrids  [read-only]

A collection of named grids.


Implementation
    public function get namedGrids():NamedGrids
notePreferencesproperty 
notePreferences:NotePreference  [read-only]

Note preference settings.


Implementation
    public function get notePreferences():NotePreference
numberingListsproperty 
numberingLists:NumberingLists  [read-only]

A collection of numbered lists.


Implementation
    public function get numberingLists():NumberingLists
objectStyleGroupsproperty 
objectStyleGroups:ObjectStyleGroups  [read-only]

A collection of object style groups.


Implementation
    public function get objectStyleGroups():ObjectStyleGroups
objectStylesproperty 
objectStyles:ObjectStyles  [read-only]

A collection of object styles.


Implementation
    public function get objectStyles():ObjectStyles
pageItemDefaultsproperty 
pageItemDefaults:PageItemDefault  [read-only]

The default page item formatting for the Application.


Implementation
    public function get pageItemDefaults():PageItemDefault
panelsproperty 
panels:Panels  [read-only]

A collection of panels.


Implementation
    public function get panels():Panels
paragraphStyleGroupsproperty 
paragraphStyleGroups:ParagraphStyleGroups  [read-only]

A collection of paragraph style groups.


Implementation
    public function get paragraphStyleGroups():ParagraphStyleGroups
paragraphStylesproperty 
paragraphStyles:ParagraphStyles  [read-only]

A collection of paragraph styles.


Implementation
    public function get paragraphStyles():ParagraphStyles
parentproperty 
parent:Application  [read-only]

The parent of the Application (a Application).


Implementation
    public function get parent():Application
pasteboardPreferencesproperty 
pasteboardPreferences:PasteboardPreference  [read-only]

Pasteboard preference settings.


Implementation
    public function get pasteboardPreferences():PasteboardPreference
pdfExportPreferencesproperty 
pdfExportPreferences:PDFExportPreference  [read-only]

A collection of PDF export preferences.


Implementation
    public function get pdfExportPreferences():PDFExportPreference
pdfExportPresetsproperty 
pdfExportPresets:PDFExportPresets  [read-only]

A collection of PDF export presets.


Implementation
    public function get pdfExportPresets():PDFExportPresets
pdfPlacePreferencesproperty 
pdfPlacePreferences:PDFPlacePreference  [read-only]

The PDF place preference properties that define how PDF files are placed in the current document.


Implementation
    public function get pdfPlacePreferences():PDFPlacePreference
performanceMetricsproperty 
performanceMetrics:Object  [read-only]

The available performance metrics.


Implementation
    public function get performanceMetrics():Object
placeableFileExtensionsproperty 
placeableFileExtensions:Object  [read-only]

Lists the extensions of file types that can be placed.


Implementation
    public function get placeableFileExtensions():Object
placeableFileTypesproperty 
placeableFileTypes:Object  [read-only]

Lists the types of files that can be placed.


Implementation
    public function get placeableFileTypes():Object
polygonPreferencesproperty 
polygonPreferences:PolygonPreference  [read-only]

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


Implementation
    public function get polygonPreferences():PolygonPreference
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
preflightBookOptionsproperty 
preflightBookOptions:PreflightBookOption  [read-only]

Preflight book option settings.


Implementation
    public function get preflightBookOptions():PreflightBookOption
preflightOptionsproperty 
preflightOptions:PreflightOption  [read-only]

Preflight option settings.


Implementation
    public function get preflightOptions():PreflightOption
preflightProcessesproperty 
preflightProcesses:PreflightProcesses  [read-only]

A collection of preflight processes.


Implementation
    public function get preflightProcesses():PreflightProcesses
preflightProfilesproperty 
preflightProfiles:PreflightProfiles  [read-only]

A collection of preflight profiles.


Implementation
    public function get preflightProfiles():PreflightProfiles
preflightRulesproperty 
preflightRules:PreflightRules  [read-only]

A collection of preflight rules.


Implementation
    public function get preflightRules():PreflightRules
printerPresetsproperty 
printerPresets:PrinterPresets  [read-only]

A collection of printer presets.


Implementation
    public function get printerPresets():PrinterPresets
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
redoHistoryproperty 
redoHistory:Object  [read-only]

The names of the items in the redo stack.


Implementation
    public function get redoHistory():Object
redoNameproperty 
redoName:String  [read-only]

The name of the action on the top of the redo stack.


Implementation
    public function get redoName():String
scriptArgsproperty 
scriptArgs:ScriptArg  [read-only]

Arguments to pass to a script.


Implementation
    public function get scriptArgs():ScriptArg
scriptMenuActionsproperty 
scriptMenuActions:ScriptMenuActions  [read-only]

A collection of script menu actions.


Implementation
    public function get scriptMenuActions():ScriptMenuActions
scriptPreferencesproperty 
scriptPreferences:ScriptPreference  [read-only]

Script preferences.


Implementation
    public function get scriptPreferences():ScriptPreference
selectionproperty 
selection:Object

The selected object(s). Can also accept: Object or NothingEnum enumerator.


Implementation
    public function get selection():Object
    public function set selection(value:Object):void
serialNumberproperty 
serialNumber:String  [read-only]

The user's serial number.


Implementation
    public function get serialNumber():String
smartGuidePreferencesproperty 
smartGuidePreferences:SmartGuidePreference  [read-only]

Smart Guide preference properties.


Implementation
    public function get smartGuidePreferences():SmartGuidePreference
spellPreferencesproperty 
spellPreferences:SpellPreference  [read-only]

Spell-check preferences.


Implementation
    public function get spellPreferences():SpellPreference
storyGridDataproperty 
storyGridData:StoryGridDataInformation  [read-only]

Default properties specific to frame grids.


Implementation
    public function get storyGridData():StoryGridDataInformation
storyPreferencesproperty 
storyPreferences:StoryPreference  [read-only]

Story preference settings.


Implementation
    public function get storyPreferences():StoryPreference
storyWindowsproperty 
storyWindows:StoryWindows  [read-only]

A collection of story windows.


Implementation
    public function get storyWindows():StoryWindows
stripedStrokeStylesproperty 
stripedStrokeStyles:StripedStrokeStyles  [read-only]

A collection of striped stroke styles.


Implementation
    public function get stripedStrokeStyles():StripedStrokeStyles
strokeFillProxySettingsproperty 
strokeFillProxySettings:StrokeFillProxySetting  [read-only]

Stroke/fill proxy settings.


Implementation
    public function get strokeFillProxySettings():StrokeFillProxySetting
strokeStylesproperty 
strokeStyles:StrokeStyles  [read-only]

A collection of stroke styles.


Implementation
    public function get strokeStyles():StrokeStyles
swatchesproperty 
swatches:Swatches  [read-only]

A collection of swatches.


Implementation
    public function get swatches():Swatches
swfExportPreferencesproperty 
swfExportPreferences:SWFExportPreference  [read-only]

SWF export preferences.


Implementation
    public function get swfExportPreferences():SWFExportPreference
tableStyleGroupsproperty 
tableStyleGroups:TableStyleGroups  [read-only]

A collection of table style groups.


Implementation
    public function get tableStyleGroups():TableStyleGroups
tableStylesproperty 
tableStyles:TableStyles  [read-only]

A collection of table styles.


Implementation
    public function get tableStyles():TableStyles
taggedTextExportPreferencesproperty 
taggedTextExportPreferences:TaggedTextExportPreference  [read-only]

Tagged text export preferences.


Implementation
    public function get taggedTextExportPreferences():TaggedTextExportPreference
taggedTextImportPreferencesproperty 
taggedTextImportPreferences:TaggedTextImportPreference  [read-only]

Tagged text import preferences.


Implementation
    public function get taggedTextImportPreferences():TaggedTextImportPreference
textDefaultsproperty 
textDefaults:TextDefault  [read-only]

Text default settings.


Implementation
    public function get textDefaults():TextDefault
textEditingPreferencesproperty 
textEditingPreferences:TextEditingPreference  [read-only]

Text editing preference settings.


Implementation
    public function get textEditingPreferences():TextEditingPreference
textExportPreferencesproperty 
textExportPreferences:TextExportPreference  [read-only]

Text export preferences.


Implementation
    public function get textExportPreferences():TextExportPreference
textFramePreferencesproperty 
textFramePreferences:TextFramePreference  [read-only]

Text frame preference settings.


Implementation
    public function get textFramePreferences():TextFramePreference
textImportPreferencesproperty 
textImportPreferences:TextImportPreference  [read-only]

Text import preferences.


Implementation
    public function get textImportPreferences():TextImportPreference
textPreferencesproperty 
textPreferences:TextPreference  [read-only]

Text preference settings.


Implementation
    public function get textPreferences():TextPreference
textVariablesproperty 
textVariables:TextVariables  [read-only]

A collection of text variables.


Implementation
    public function get textVariables():TextVariables
textWrapPreferencesproperty 
textWrapPreferences:TextWrapPreference  [read-only]

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


Implementation
    public function get textWrapPreferences():TextWrapPreference
tintsproperty 
tints:Tints  [read-only]

A collection of tints.


Implementation
    public function get tints():Tints
toolBoxToolsproperty 
toolBoxTools:ToolBox  [read-only]

The current tool box states


Implementation
    public function get toolBoxTools():ToolBox
trackChangesPreferencesproperty 
trackChangesPreferences:TrackChangesPreference  [read-only]

Track changes preference settings.


Implementation
    public function get trackChangesPreferences():TrackChangesPreference
transformationMatricesproperty 
transformationMatrices:TransformationMatrices  [read-only]

A collection of transformation matrices.


Implementation
    public function get transformationMatrices():TransformationMatrices
transformPreferencesproperty 
transformPreferences:TransformPreference  [read-only]

Transform preference properties that define default behaviors when transforming objects. Note: Transforming includes rotation, scaling, flipping, and shearing.


Implementation
    public function get transformPreferences():TransformPreference
transparencyPreferencesproperty 
transparencyPreferences:TransparencyPreference  [read-only]

Transparency preference settings.


Implementation
    public function get transparencyPreferences():TransparencyPreference
trapPresetsproperty 
trapPresets:TrapPresets  [read-only]

A collection of trap presets.


Implementation
    public function get trapPresets():TrapPresets
undoHistoryproperty 
undoHistory:Object  [read-only]

The names of the items in the undo stack.


Implementation
    public function get undoHistory():Object
undoNameproperty 
undoName:String  [read-only]

The name of the action on the top of the undo stack.


Implementation
    public function get undoName():String
unusedSwatchesproperty 
unusedSwatches:Object  [read-only]

The swatches that are not being used.


Implementation
    public function get unusedSwatches():Object
userColorproperty 
userColor:Object

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.


Implementation
    public function get userColor():Object
    public function set userColor(value:Object):void
userDictionariesproperty 
userDictionaries:UserDictionaries  [read-only]

A collection of user dictionaries.


Implementation
    public function get userDictionaries():UserDictionaries
userNameproperty 
userName:String

The user associated with the tracked changes and notes.


Implementation
    public function get userName():String
    public function set userName(value:String):void
versionproperty 
version:String  [read-only]

The application version.


Implementation
    public function get version():String
viewPreferencesproperty 
viewPreferences:ViewPreference  [read-only]

View preference settings.


Implementation
    public function get viewPreferences():ViewPreference
visibleproperty 
visible:Boolean  [read-only]

If true, the Application is visible.


Implementation
    public function get visible():Boolean
watermarkPreferencesproperty 
watermarkPreferences:WatermarkPreference  [read-only]

Watermark preferences


Implementation
    public function get watermarkPreferences():WatermarkPreference
windowsproperty 
windows:Windows  [read-only]

A collection of windows.


Implementation
    public function get windows():Windows
wordRTFImportPreferencesproperty 
wordRTFImportPreferences:WordRTFImportPreference  [read-only]

Word and RTF import preferences.


Implementation
    public function get wordRTFImportPreferences():WordRTFImportPreference
xflExportPreferencesproperty 
xflExportPreferences:XFLExportPreference  [read-only]

XFL export preferences.


Implementation
    public function get xflExportPreferences():XFLExportPreference
xmlExportMapsproperty 
xmlExportMaps:XMLExportMaps  [read-only]

A collection of XML export maps.


Implementation
    public function get xmlExportMaps():XMLExportMaps
xmlExportPreferencesproperty 
xmlExportPreferences:XMLExportPreference  [read-only]

XML export preference settings.


Implementation
    public function get xmlExportPreferences():XMLExportPreference
xmlImportMapsproperty 
xmlImportMaps:XMLImportMaps  [read-only]

A collection of XML import maps.


Implementation
    public function get xmlImportMaps():XMLImportMaps
xmlImportPreferencesproperty 
xmlImportPreferences:XMLImportPreference  [read-only]

XML import preference settings.


Implementation
    public function get xmlImportPreferences():XMLImportPreference
xmlPreferencesproperty 
xmlPreferences:XMLPreference  [read-only]

The XML preference settings.


Implementation
    public function get xmlPreferences():XMLPreference
xmlRuleProcessorsproperty 
xmlRuleProcessors:XMLRuleProcessors  [read-only]

A collection of XML rule processors.


Implementation
    public function get xmlRuleProcessors():XMLRuleProcessors
xmlTagsproperty 
xmlTags:XMLTags  [read-only]

A collection of XML tags.


Implementation
    public function get xmlTags():XMLTags
xmlViewPreferencesproperty 
xmlViewPreferences:XMLViewPreference  [read-only]

XML view preference settings.


Implementation
    public function get xmlViewPreferences():XMLViewPreference
Method Detail
activate()method
public function activate():void

Makes the application the front-most or active window.

addEventListenerApplication()method 
public function addEventListenerApplication(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
applyMenuCustomization()method 
public function applyMenuCustomization(nameParam:String = null):void

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

Parameters

nameParam:String (default = null) — (String) The menu customization set. (Optional)

applyShortcutSet()method 
public function applyShortcutSet(nameParam:String = null):void

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

Parameters

nameParam:String (default = null) — (String) The shortcut set. (Optional)

applyWorkspace()method 
public function applyWorkspace(nameParam:String = null):void

Applies the specified workspace.

Parameters

nameParam:String (default = null) — (String) The workspace. (Optional)

cancelAllTasks()method 
public function cancelAllTasks():void

Cancels all the background tasks.

cascadeWindows()method 
public function cascadeWindows():void

Cascades all document windows.

changeGlyph()method 
public function changeGlyph(reverseOrderParam:Boolean):Object

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

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
changeGrep()method 
public function changeGrep(reverseOrderParam:Boolean):Object

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

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
changeObject()method 
public function changeObject(reverseOrderParam:Boolean):Object

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

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
changeText()method 
public function changeText(reverseOrderParam:Boolean):Object

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

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
changeTransliterate()method 
public function changeTransliterate(reverseOrderParam:Boolean):Object

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

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
clearFrameFittingOptions()method 
public function clearFrameFittingOptions():void

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

copy()method 
public function copy():void

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

cut()method 
public function cut():void

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

deleteFindChangeQuery()method 
public function deleteFindChangeQuery(queryNameParam:String = null, searchModeParam:SearchModes = null):void

Deletes the specified find/change query.

Parameters

queryNameParam:String (default = null) — (String) The query to delete.
 
searchModeParam:SearchModes (default = null) — (SearchModes) The search mode.

deleteUnusedTags()method 
public function deleteUnusedTags():void

Deletes unused XML markup tags.

dommygeneratecode()method 
public function dommygeneratecode(dommytemplateinputfolderParam:String = null, dommycodeoutputfolderParam:String = null):void

Generate Code Via DommyDumper

Parameters

dommytemplateinputfolderParam:String (default = null) — (String) Holds path to template folder as string
 
dommycodeoutputfolderParam:String (default = null) — (String) Holds path to code output folder as string

doScript()method 
public function doScript(scriptParam:Object = null, languageParam:ScriptLanguage = null, withArgumentsParam:Array = null, undoModeParam:UndoModes = null, undoNameParam:String = Script):Object

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

Parameters

scriptParam:Object (default = null) — (Object) The script to execute. Can accept: File, String or JavaScript Function.
 
languageParam:ScriptLanguage (default = null) — (ScriptLanguage) The language of the script to execute. If not specified, uses the language used to call this method. (Optional)
 
withArgumentsParam:Array (default = null) — (Array) An array of arguments passed to the script. (Optional)
 
undoModeParam:UndoModes (default = null) — (UndoModes) How to undo this script. (Optional)
 
undoNameParam:String (default = Script) — (String) The name of the undo step for entire script undo mode. (Optional)

Returns
Object
dumpBetweenMemoryMarks()method 
public function dumpBetweenMemoryMarks(fromParam:Number, toParam:Number):void

Dumps memory allocations from all marks in the specified range.

Parameters

fromParam:Number (default = NaN) — (Number) The first mark in the range.
 
toParam:Number (default = NaN) — (Number) The last mark in the range.

dumpFromMemoryMark()method 
public function dumpFromMemoryMark(fromParam:Number):void

Dumps memory allocations from the specified mark.

Parameters

fromParam:Number (default = NaN) — (Number) The mark from which to dump memory.

exportPresets()method 
public function exportPresets(formatParam:ExportPresetFormat = null, toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Export the presets to a file.

Parameters

formatParam:ExportPresetFormat (default = null) — (ExportPresetFormat) The preset format.
 
toParam:File (default = null) — (File) The file to export to.
 
versionCommentsParam:String (default = null) — (String) The comments for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) Forcibly save a version. (Optional)

exportStrokeStyles()method 
public function exportStrokeStyles(toParam:File = null, strokeStyleListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Exports stroke styles or presets.

Parameters

toParam:File (default = null) — (File) The file to save to
 
strokeStyleListParam:Array (default = null) — (Array) The list of stroke styles to save
 
versionCommentsParam:String (default = null) — (String) The comment for this version (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) Forcibly save a version (Optional)

extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
findGlyph()method 
public function findGlyph(reverseOrderParam:Boolean):Object

Finds glyphs that match the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findGrep()method 
public function findGrep(reverseOrderParam:Boolean):Object

Finds text that matches the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findKeyStrings()method 
public function findKeyStrings(forParam:String = null):Object

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

Parameters

forParam:String (default = null) — (String) The string to search for.

Returns
Object
findObject()method 
public function findObject(reverseOrderParam:Boolean):Object

Finds objects that match the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findText()method 
public function findText(reverseOrderParam:Boolean):Object

Finds text that matches the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findTransliterate()method 
public function findTransliterate(reverseOrderParam:Boolean):Object

Finds text that matches the find character type value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
generateIDMLSchema()method 
public function generateIDMLSchema(toParam:File = null, packageFormatParam:Boolean):void

Generate schema for IDML.

Parameters

toParam:File (default = null) — (File) The folder path of the schema.
 
packageFormatParam:Boolean (default = NaN) — (Boolean) If true, generate schema for package format (multiple files). Default value is false. (Optional)

getDocumentsIds()method 
public function getDocumentsIds():String

Gets the instance ids of all open documents.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
importAdobeSwatchbookProcessColor()method 
public function importAdobeSwatchbookProcessColor(nameParam:String = null):Color

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

Parameters

nameParam:String (default = null) — (String) The process color to load.

Returns
Color
importAdobeSwatchbookSpotColor()method 
public function importAdobeSwatchbookSpotColor(nameParam:String = null):Color

Imports a spot color swatch from an Adobe color book.

Parameters

nameParam:String (default = null) — (String) The spot color to load.

Returns
Color
importFile()method 
public function importFile(formatParam:ExportPresetFormat = null, fromParam:File = null):void

Imports presets from the specified file.

Parameters

formatParam:ExportPresetFormat (default = null) — (ExportPresetFormat) The type of preset to import.
 
fromParam:File (default = null) — (File) The file to import presets from.

importStyles()method 
public function importStyles(formatParam:ImportFormat = null, fromParam:File = null, globalStrategyParam:GlobalClashResolutionStrategy = null):void

Imports the specified styles.

Parameters

formatParam:ImportFormat (default = null) — (ImportFormat) The types of styles to import.
 
fromParam:File (default = null) — (File) The file containing the styles you want to import.
 
globalStrategyParam:GlobalClashResolutionStrategy (default = null) — (GlobalClashResolutionStrategy) The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional)

insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

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

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

jumpToComment()method 
public function jumpToComment(documentidParam:String = null, commentdataParam:String = null):void

Jump to the specified comment in open document.

Parameters

documentidParam:String (default = null) — (String) Document ID for comment to jump to.
 
commentdataParam:String (default = null) — (String) Info about the comment to jump to.

loadConditions()method 
public function loadConditions(fromParam:File = null, loadConditionSetsParam:Boolean):void

Load conditions from the specified file.

Parameters

fromParam:File (default = null) — (File) The path to the file that contains the conditions.
 
loadConditionSetsParam:Boolean (default = NaN) — (Boolean) If true, load the condition sets as well. (Optional)

loadFindChangeQuery()method 
public function loadFindChangeQuery(queryNameParam:String = null, searchModeParam:SearchModes = null):void

Loads the specified find/change query.

Parameters

queryNameParam:String (default = null) — (String) The query to load.
 
searchModeParam:SearchModes (default = null) — (SearchModes) The search mode.

loadMotionPreset()method 
public function loadMotionPreset(fromParam:File = null):MotionPreset

Load motion preset from the specified file.

Parameters

fromParam:File (default = null) — (File) The Flash motion preset file.

Returns
MotionPreset
loadPreflightProfile()method 
public function loadPreflightProfile(fromParam:File = null):PreflightProfile

Load preflight profile from the specified file.

Parameters

fromParam:File (default = null) — (File) The InDesign preflight profile file or InDesign document.

Returns
PreflightProfile
loadSwatches()method 
public function loadSwatches(fromParam:File = null):void

Load swatches from the specified file.

Parameters

fromParam:File (default = null) — (File) The swatch file or InDesign document.

loadXMLTags()method 
public function loadXMLTags(fromParam:File = null):void

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

Parameters

fromParam:File (default = null) — (File) The path to the file that contains the tags.

memoryStatistics()method 
public function memoryStatistics():Object

Gets the memory statistics from the server.

Returns
Object
mountProject()method 
public function mountProject(serverURLParam:String = null, projectNameParam:String = null):void

Mount a Version Cue project.

Parameters

serverURLParam:String (default = null) — (String) The URL of the Version Cue server containing the project
 
projectNameParam:String (default = null) — (String) The name of the Version Cue project to mount

open()method 
public function open(fromParam:Object = null, showingWindowParam:Boolean = true, openOptionParam:OpenOptions = null):Object

Opens the specified document, book, or library.

Parameters

fromParam:Object (default = null) — (Object) The file path(s) to the document, book, or library. Can accept: File or Array of Files.
 
showingWindowParam:Boolean (default = true) — (Boolean) If true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional)
 
openOptionParam:OpenOptions (default = null) — (OpenOptions) How to open the document. (Optional)

Returns
Object
packageUCF()method 
public function packageUCF(sourceFolderParam:File = null, ucfFileParam:File = null, mimeMediaTypeParam:String = application/vnd.adobe.indesign-idml-package):void

Package a folder into a UCF file.

Parameters

sourceFolderParam:File (default = null) — (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.
 
ucfFileParam:File (default = null) — (File) The destination UCF file. Will be overwritten if it already exists.
 
mimeMediaTypeParam:String (default = application/vnd.adobe.indesign-idml-package) — (String) The MIME media type, default value identifies package as IDML. (Optional)

paste()method 
public function paste():void

Pastes data from the clipboard into the active document window.

pasteInPlace()method 
public function pasteInPlace():void

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

pasteInto()method 
public function pasteInto():void

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

pasteWithoutFormatting()method 
public function pasteWithoutFormatting():void

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

performanceMetric()method 
public function performanceMetric(forParam:Object = null):Object

Gets the current value of the specified performance metric.

Parameters

forParam:Object (default = null) — (Object) The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator.

Returns
Object
performanceMetricLongName()method 
public function performanceMetricLongName(forParam:Object = null):String

Gets the long name of the specified performance metric.

Parameters

forParam:Object (default = null) — (Object) The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator.

Returns
String
performanceMetricShortName()method 
public function performanceMetricShortName(forParam:Object = null):String

Gets the short name of the specified performance metric.

Parameters

forParam:Object (default = null) — (Object) The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator.

Returns
String
place()method 
public function place(fileNameParam:Object = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):void

Place one or more files following the behavior of the place menu item. This may load the place gun or replace the selected object, depending on current preferences.

Parameters

fileNameParam:Object (default = null) — (Object) One or more files to place. Can accept: File or Array of Files.
 
showingOptionsParam:Boolean (default = false) — (Boolean) Whether to display the import options dialog (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the placed object(s) (Optional)

print()method 
public function print(fromParam:Object = null, printDialogParam:Boolean, usingParam:Object = null):void

Prints the specified file(s).

Parameters

fromParam:Object (default = null) — (Object) One or more file paths. Can accept: File or Array of Files.
 
printDialogParam:Boolean (default = NaN) — (Boolean) Whether to invoke the print dialog (Optional)
 
usingParam:Object (default = null) — (Object) Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

quit()method 
public function quit(savingParam:SaveOptions = null):void

Quits the application.

Parameters

savingParam:SaveOptions (default = null) — (SaveOptions) The option to use for saving changes to open documents before quitting. (Optional)

redo()method 
public function redo():void

Redoes the last action.

removeEventListenerApplication()method 
public function removeEventListenerApplication(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
saveFindChangeQuery()method 
public function saveFindChangeQuery(queryNameParam:String = null, searchModeParam:SearchModes = null):void

Saves the specified find/change query.

Parameters

queryNameParam:String (default = null) — (String) The query to save.
 
searchModeParam:SearchModes (default = null) — (SearchModes) The search mode.

saveSwatches()method 
public function saveSwatches(toParam:File = null, swatchListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

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

Parameters

toParam:File (default = null) — (File) The swatchbook file to save to.
 
swatchListParam:Array (default = null) — (Array) The swatch(es) to save.
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

saveXMLTags()method 
public function saveXMLTags(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Saves a set of tags to an external file.

Parameters

toParam:File (default = null) — (File) The full path to the file in which to save the tags.
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

select()method 
public function select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void

Selects the specified object(s).

Parameters

selectableItemsParam:Object (default = null) — (Object) The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
 
existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the Application in relation to previously selected objects. (Optional)

setApplicationPreferences()method 
public function setApplicationPreferences(applicationPreferencesParam:Object = null):void

Sets the application's preferences.

Parameters

applicationPreferencesParam:Object (default = null) — (Object) The IDML defaults file or enumeration. Can accept: File or LanguageAndRegion enumerator.

tileWindows()method 
public function tileWindows():void

Tile all document windows

togglePanelSystemVisibility()method 
public function togglePanelSystemVisibility():void

Toggles the visibility of the entire panel system.

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
translateKeyString()method 
public function translateKeyString(forParam:String = null):String

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

Parameters

forParam:String (default = null) — (String) The key string to translate

Returns
String
undo()method 
public function undo():void

Undoes the last action.

unpackageUCF()method 
public function unpackageUCF(ucfFileParam:File = null, destinationFolderParam:File = null):void

Unpackage a UCF file into a folder structure.

Parameters

ucfFileParam:File (default = null) — (File) The UCF file to be unpackaged.
 
destinationFolderParam:File (default = null) — (File) The folder where you would like the UCF file unpackaged to. Will be created if it does not exist.

updateBuzzwordLinkInfo()method 
public function updateBuzzwordLinkInfo(docIdParam:String = null, statusParam:LinkStatus = null, statusInfoParam:String = null, titleParam:String = null, docVersionParam:String = null, contentVersionParam:String = null, modYearParam:Number, modMonthParam:Number, modDayParam:Number, modHourParam:Number, modMinuteParam:Number, modSecondParam:Number):String

Update the link resource info of buzzword link.

Parameters

docIdParam:String (default = null) — (String) Buzzword document id for the link resource to be updated.
 
statusParam:LinkStatus (default = null) — (LinkStatus) new status of the link.
 
statusInfoParam:String (default = null) — (String) Customized status info string for Buzzword link. (Optional)
 
titleParam:String (default = null) — (String) Document title for Buzzword link. (Optional)
 
docVersionParam:String (default = null) — (String) Buzzword document version. (Optional)
 
contentVersionParam:String (default = null) — (String) Buzzword document content version (Optional)
 
modYearParam:Number (default = NaN) — (Number) the modification year for the Buzzword document (Optional)
 
modMonthParam:Number (default = NaN) — (Number) the modification month for the Buzzword document (Optional)
 
modDayParam:Number (default = NaN) — (Number) the modification day for the Buzzword document (Optional)
 
modHourParam:Number (default = NaN) — (Number) the modification hour for the Buzzword document (Optional)
 
modMinuteParam:Number (default = NaN) — (Number) the modification minute for the Buzzword document (Optional)
 
modSecondParam:Number (default = NaN) — (Number) the modification second for the Buzzword document (Optional)

Returns
String
updateFonts()method 
public function updateFonts():void

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

waitForAllTasks()method 
public function waitForAllTasks():Object

Waits for all the background tasks to finish.

Returns
Object