Packagecom.adobe.indesign
Classpublic class Document
InheritanceDocument Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  accurateLABSpots : Boolean
If true, uses LAB alternates for spot colors when available.
Document
  activeLayer : Layer
The active layer.
Document
  activeProcess : PreflightProcess
[read-only] The active preflight process for this document.
Document
  AFTER_ACTIVATE : String
[static] [read-only] Dispatched after the Document becomes active.
Document
  afterBlendingIntent : RenderingIntent
The rendering intent for colors that result from transparency interactions on the page after blending.
Document
  AFTER_EXPORT : String
[static] [read-only] Dispatched after a Document is exported.
Document
  AFTER_IMPORT : String
[static] [read-only] Dispatched after importing a file into a Document.
Document
  AFTER_LINKS_CHANGED : String
[static] [read-only] Dispatched after one or more links in the Document have been added, deleted, or modified.
Document
  AFTER_NEW : String
[static] [read-only] Dispatched after a Document is created.
Document
  AFTER_OPEN : String
[static] [read-only] Dispatched after a Document is opened.
Document
  AFTER_PRINT : String
[static] [read-only] Dispatched after a Document is printed.
Document
  AFTER_REVERT : String
[static] [read-only] Dispatched after a Document is reverted.
Document
  AFTER_SAVE : String
[static] [read-only] Dispatched after a Document is saved.
Document
  AFTER_SAVE_A_COPY : String
[static] [read-only] Dispatched after a copy of a Document is saved.
Document
  AFTER_SAVE_AS : String
[static] [read-only] Dispatched after a Document is saved under a new name.
Document
  allCellStyles : Object
[read-only] All Cell styles
Document
  allCharacterStyles : Object
[read-only] Lists all character styles (regardless of their group).
Document
  allGraphics : Object
[read-only] Lists all graphics contained by the Document.
Document
  allObjectStyles : Object
[read-only] All object styles contained by the Document.
Document
  allPageItems : Object
[read-only] Lists all page items contained by the Document.
Document
  allParagraphStyles : Object
[read-only] Lists all paragraph styles (regardless of their group).
Document
  allTableStyles : Object
[read-only] All Table styles
Document
  anchoredObjectDefaults : AnchoredObjectDefault
[read-only] Anchored object default settings.
Document
  anchoredObjectSettings : AnchoredObjectSetting
[read-only] Anchored object settings.
Document
  assignments : Assignments
[read-only] A collection of assignments.
Document
  associatedXMLElement : XMLItem
[read-only] The XML element associated with the Document.
Document
  baselineFrameGridOptions : BaselineFrameGridOption
[read-only] Baseline frame grid option settings.
Document
  BEFORE_CLOSE : String
[static] [read-only] Dispatched before a Document is closed.
Document
  BEFORE_DEACTIVATE : String
[static] [read-only] Dispatched before the Document becomes inactive.
Document
  BEFORE_EXPORT : String
[static] [read-only] Dispatched before a Document is exported.
Document
  BEFORE_IMPORT : String
[static] [read-only] Dispatched before importing a file into a Document.
Document
  BEFORE_PRINT : String
[static] [read-only] Dispatched before a Document is printed.
Document
  BEFORE_REVERT : String
[static] [read-only] Dispatched before a Document is reverted.
Document
  BEFORE_SAVE : String
[static] [read-only] Dispatched before a Document is saved.
Document
  BEFORE_SAVE_A_COPY : String
[static] [read-only] Dispatched before a copy of a Document is saved.
Document
  BEFORE_SAVE_AS : String
[static] [read-only] Dispatched before a Document is saved under a new name.
Document
  bookmarks : Bookmarks
[read-only] A collection of bookmarks.
Document
  buttonPreferences : ButtonPreference
[read-only] Button preference settings.
Document
  buttons : Buttons
[read-only] A collection of buttons.
Document
  cellStyleGroups : CellStyleGroups
[read-only] A collection of cell style groups.
Document
  cellStyles : CellStyles
[read-only] A collection of cell styles.
Document
  chapterNumberPreferences : ChapterNumberPreference
[read-only] Chapter numbering preferences.
Document
  characterStyleGroups : CharacterStyleGroups
[read-only] A collection of character style groups.
Document
  characterStyles : CharacterStyles
[read-only] A collection of character styles.
Document
  cjkGridPreferences : CjkGridPreference
[read-only] CJK grid preference settings.
Document
  cmykPolicy : ColorSettingsPolicy
The policy for handling colors in a CMYK color model, including reading and embedding color profiles, mismatches between embedded color profiles and the working space, and moving colors from one document to another.
Document
  cmykProfile : String
The current CMYK profile.
Document
  cmykProfileList : Object
[read-only] A list of valid CMYK profiles.
Document
  colors : Colors
[read-only] A collection of colors.
Document
  compositeFonts : CompositeFonts
[read-only] A collection of composite fonts.
Document
  conditionalTextPreferences : ConditionalTextPreference
[read-only] Conditional text preferences.
Document
  conditions : Conditions
[read-only] A collection of conditions for conditional text.
Document
  conditionSets : ConditionSets
[read-only] A collection of condition sets for conditional text.
Document
  converted : Boolean
[read-only] If true, the Document was converted.
Document
  crossReferenceFormats : CrossReferenceFormats
[read-only] A collection of cross reference formats.
Document
  crossReferenceSources : CrossReferenceSources
[read-only] A collection of cross reference text sources.
Document
  dashedStrokeStyles : DashedStrokeStyles
[read-only] A collection of dashed stroke styles.
Document
  dataMergeImagePlaceholders : DataMergeImagePlaceholders
[read-only] A collection of data merge image placeholders.
Document
  dataMergeOptions : DataMergeOption
[read-only] The data merge option properties that define the data merge.
Document
  dataMergeProperties : DataMerge
[read-only] Data merge properties that define data merge fields and preferences.
Document
  dataMergeTextPlaceholders : DataMergeTextPlaceholders
[read-only] A collection of data merge text placeholders.
Document
  defaultImageIntent : RenderingIntent
The rendering intent for bitmap images.
Document
  dictionaryPreferences : DictionaryPreference
[read-only] User dictionary preference settings.
Document
  documentPreferences : DocumentPreference
[read-only] Document preference settings.
Document
  dottedStrokeStyles : DottedStrokeStyles
[read-only] A collection of dotted stroke styles.
Document
  dtds : DTDs
[read-only] A collection of DTDs.
Document
  editingState : EditingState
[read-only] The Version Cue editing state of the file.
Document
  epstexts : EPSTexts
[read-only] EPSTexts
Document
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Document
  events : Events
[read-only] A collection of events.
Document
  exportForWebPreferences : ExportForWebPreference
[read-only] The default export for web preferences.
Document
  FAILED_EXPORT : String
[static] [read-only] Dispatched after a Document export is canceled or fails.
Document
  filePath : File
[read-only] The full path to the file.
Document
  fonts : Fonts
[read-only] A collection of fonts.
Document
  footnoteOptions : FootnoteOption
[read-only] Footnote option settings.
Document
  formFields : FormFields
[read-only] A collection of form fields.
Document
  frameFittingOptions : FrameFittingOption
[read-only] The frame fitting option to apply to placed or pasted content.
Document
  fullName : File
[read-only] The full path to the Document, including the name of the Document.
Document
  galleyPreferences : GalleyPreference
[read-only] Galley preference settings.
Document
  gradients : Gradients
[read-only] A collection of gradients.
Document
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
Document
  gridPreferences : GridPreference
[read-only] Grid preference settings.
Document
  groups : Groups
[read-only] A collection of groups.
Document
  guidePreferences : GuidePreference
[read-only] Guide preference settings.
Document
  guides : Guides
[read-only] A collection of guides.
Document
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  hyperlinkExternalPageDestinations : HyperlinkExternalPageDestinations
[read-only] A collection of hyperlink external page destinations.
Document
  hyperlinkPageDestinations : HyperlinkPageDestinations
[read-only] A collection of hyperlink page destinations.
Document
  hyperlinkPageItemSources : HyperlinkPageItemSources
[read-only] A collection of hyperlink page item sources.
Document
  hyperlinks : Hyperlinks
[read-only] A collection of hyperlinks.
Document
  hyperlinkTextDestinations : HyperlinkTextDestinations
[read-only] A collection of hyperlink text destinations.
Document
  hyperlinkTextSources : HyperlinkTextSources
[read-only] A collection of hyperlink text sources.
Document
  hyperlinkURLDestinations : HyperlinkURLDestinations
[read-only] A collection of hyperlink URL destinations.
Document
  hyphenationExceptions : HyphenationExceptions
[read-only] A collection of hyphenation exceptions lists.
Document
  id : Number
[read-only] The unique ID of the Document.
Document
  index : Number
[read-only] The index of the Document within its containing object.
Document
  indexes : Indexes
[read-only] A collection of indexes.
Document
  indexGenerationOptions : IndexOptions
[read-only] The index options properties that define how an index is formatted.
Document
  indexingSortOptions : IndexingSortOptions
[read-only] A collection of indexing sort options.
Document
  inks : Inks
[read-only] A collection of inks.
Document
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Document
  kinsokuTables : KinsokuTables
[read-only] A collection of kinsoku tables.
Document
  label : String
A property that can be set to any string.
Document
  languages : Languages
[read-only] A collection of languages.
Document
  layers : Layers
[read-only] A collection of layers.
Document
  layoutAdjustmentPreferences : LayoutAdjustmentPreference
[read-only] Layout sdjustment preference settings.
Document
  layoutGridData : LayoutGridDataInformation
[read-only] Default properties specific to layout grids.
Document
  layoutWindows : LayoutWindows
[read-only] A collection of layout windows.
Document
  links : Links
[read-only] A collection of links.
Document
  marginPreferences : MarginPreference
[read-only] Margin preference settings.
Document
  masterSpreads : MasterSpreads
[read-only] A collection of master spreads.
Document
  metadataPreferences : MetadataPreference
[read-only] Metadata preference settings.
Document
  mixedInkGroups : MixedInkGroups
[read-only] A collection of mixed ink groups.
Document
  mixedInks : MixedInks
[read-only] A collection of mixed inks.
Document
  modified : Boolean
[read-only] If true, the Document has been modified since it was last saved.
Document
  mojikumiTables : MojikumiTables
[read-only] A collection of mojikumi tables.
Document
  mojikumiUIPreferences : MojikumiUiPreference
[read-only] Mojikumi user interface preference settings.
Document
  motionPresets : MotionPresets
[read-only] A collection of Motion presets.
Document
  multiStateObjects : MultiStateObjects
[read-only] A collection of multi-state objects.
Document
  name : String
[read-only] The name of the Document.
Document
  namedGrids : NamedGrids
[read-only] A collection of named grids.
Document
  numberingLists : NumberingLists
[read-only] A collection of numbered lists.
Document
  objectStyleGroups : ObjectStyleGroups
[read-only] A collection of object style groups.
Document
  objectStyles : ObjectStyles
[read-only] A collection of object styles.
Document
  ovals : Ovals
[read-only] A collection of ellipses.
Document
  pageItemDefaults : PageItemDefault
[read-only] The default page item formatting for the Document.
Document
  pageItems : PageItems
[read-only] The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
Document
  pages : Pages
[read-only] A collection of pages.
Document
  paragraphDestinations : ParagraphDestinations
[read-only] A collection of paragraph destinations.
Document
  paragraphStyleGroups : ParagraphStyleGroups
[read-only] A collection of paragraph style groups.
Document
  paragraphStyles : ParagraphStyles
[read-only] A collection of paragraph styles.
Document
  parent : Application
[read-only] The parent of the Document (a Application).
Document
  pasteboardPreferences : PasteboardPreference
[read-only] Pasteboard preference settings.
Document
  placeGuns : PlaceGun
[read-only] The place gun.
Document
  polygons : Polygons
[read-only] A collection of polygons.
Document
  preferences : Preferences
[read-only] A collection of preferences objects.
Document
  preflightOptions : PreflightOption
[read-only] Preflight option settings.
Document
  preflightProfiles : PreflightProfiles
[read-only] A collection of preflight profiles.
Document
  printBookletOptions : PrintBookletOption
[read-only] Booklet printing options.
Document
  printBookletPrintPreferences : PrintBookletPrintPreference
[read-only] Print booklet preferences.
Document
  printPreferences : PrintPreference
[read-only] Print preference settings.
Document
  properties : Object
A property that allows setting of several properties at the same time.
Document
  readOnly : Boolean
[read-only] If true, the Document is read-only.
Document
  recovered : Boolean
[read-only] If true, the Document was recovered.
Document
  rectangles : Rectangles
[read-only] A collection of rectangles.
Document
  redoHistory : Object
[read-only] The names of the items in the redo stack.
Document
  redoName : String
[read-only] The name of the action on the top of the redo stack.
Document
  rgbPolicy : ColorSettingsPolicy
The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another.
Document
  rgbProfile : String
The current RGB profile.
Document
  rgbProfileList : Object
[read-only] A list of valid RGB profiles.
Document
  saved : Boolean
[read-only] If true, the Document has been saved since it was created.
Document
  sections : Sections
[read-only] A collection of sections.
Document
  selection : Object
The selected object(s).
Document
  solidColorIntent : RenderingIntent
The rendering intent for all vector art (areas of solid color) in native objects.
Document
  splineItems : SplineItems
[read-only] The spline items collection.
Document
  spreads : Spreads
[read-only] A collection of spreads.
Document
  stories : Stories
[read-only] A collection of stories.
Document
  storyGridData : StoryGridDataInformation
[read-only] Default properties specific to frame grids.
Document
  storyPreferences : StoryPreference
[read-only] Story preference settings.
Document
  storyWindows : StoryWindows
[read-only] A collection of story windows.
Document
  stripedStrokeStyles : StripedStrokeStyles
[read-only] A collection of striped stroke styles.
Document
  strokeStyles : StrokeStyles
[read-only] A collection of stroke styles.
Document
  swatches : Swatches
[read-only] A collection of swatches.
Document
  switchbackCommentData : String
The comment data to display (XML as string).
Document
  tableStyleGroups : TableStyleGroups
[read-only] A collection of table style groups.
Document
  tableStyles : TableStyles
[read-only] A collection of table styles.
Document
  textDefaults : TextDefault
[read-only] Text default settings.
Document
  textFramePreferences : TextFramePreference
[read-only] Text frame preference settings.
Document
  textFrames : TextFrames
[read-only] A collection of text frames.
Document
  textPreferences : TextPreference
[read-only] Text preference settings.
Document
  textVariables : TextVariables
[read-only] A collection of text variables.
Document
  textWrapPreferences : TextWrapPreference
[read-only] The text wrap preference properties that define the default formatting for wrapping text around objects.
Document
  tints : Tints
[read-only] A collection of tints.
Document
  tocStyles : TOCStyles
[read-only] A collection of TOC styles.
Document
  transparencyPreferences : TransparencyPreference
[read-only] Transparency preference settings.
Document
  trapPresets : TrapPresets
[read-only] A collection of trap presets.
Document
  undoHistory : Object
[read-only] The names of the items in the undo stack.
Document
  undoName : String
[read-only] The name of the action on the top of the undo stack.
Document
  unusedSwatches : Object
[read-only] The swatches that are not being used.
Document
  validationErrors : ValidationErrors
[read-only] A collection of XML validation errors.
Document
  versionState : VersionState
[read-only] The Version Cue version state of the file.
Document
  viewPreferences : ViewPreference
[read-only] View preference settings.
Document
  visible : Boolean
[read-only] If true, the Document is visible.
Document
  watermarkPreferences : WatermarkPreference
[read-only] Watermark preferences
Document
  windows : Windows
[read-only] A collection of windows.
Document
  xmlComments : XMLComments
[read-only] A collection of XML comments.
Document
  xmlElements : XMLElements
[read-only] A collection of XML elements.
Document
  xmlExportMaps : XMLExportMaps
[read-only] A collection of XML export maps.
Document
  xmlExportPreferences : XMLExportPreference
[read-only] XML export preference settings.
Document
  xmlImportMaps : XMLImportMaps
[read-only] A collection of XML import maps.
Document
  xmlImportPreferences : XMLImportPreference
[read-only] XML import preference settings.
Document
  xmlInstructions : XMLInstructions
[read-only] A collection of XML instructions.
Document
  xmlItems : XMLItems
[read-only] A collection of XML items.
Document
  xmlPreferences : XMLPreference
[read-only] The XML preference settings.
Document
  xmlStories : XmlStories
[read-only] A collection of xml stories.
Document
  xmlTags : XMLTags
[read-only] A collection of XML tags.
Document
  xmlViewPreferences : XMLViewPreference
[read-only] XML view preference settings.
Document
  zeroPoint : Object
The ruler origin, specified as page coordinates in the format [x, y].
Document
Public Methods
 MethodDefined By
  
addEventListenerDocument(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Document
  
align(alignDistributeItemsParam:Array = null, alignOptionParam:AlignOptions = null, alignDistributeBoundsParam:AlignDistributeBounds = null):void
Align page items.
Document
  
asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask
asynchronously exports the object(s) to a file.
Document
  
Change comoser to optyca
Document
  
changeGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Document
  
changeGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value.
Document
  
changeObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value and replace the objects with the change to value.
Document
  
changeText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value.
Document
  
changeTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value and replaces the text with the change character type value.
Document
  
checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Check in to Version Cue.
Document
  
Removes the frame fittings options and resets it to the initial state.
Document
  
close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Close the Document
Document
  
createTOC(usingParam:TOCStyle = null, replacingParam:Boolean = false, fromBookParam:Book = null, placePointParam:Array = null, includeOversetParam:Boolean = false, destinationLayerParam:Layer = null):Object
Creates a table of contents.
Document
  
Deletes unused XML markup tags.
Document
  
distribute(alignDistributeItemsParam:Array = null, distributeOptionParam:DistributeOptions = null, alignDistributeBoundsParam:AlignDistributeBounds = null, useDistributeMeasurementParam:Boolean, absoluteDistributeMeasurementParam:Object = null):void
Distribute page items.
Document
  
embed(usingParam:Object = null):PreflightProfile
Embed this profile to the document.
Document
  
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports the object(s) to a file.
Document
  
exportStrokeStyles(toParam:File = null, strokeStyleListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports stroke styles or presets.
Document
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Document
 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.
Document
  
findGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value.
Document
  
findObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value.
Document
  
findText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value.
Document
  
findTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value.
Document
  
generateDocContent(tasknameParam:String = null, reviewnameParam:String = null, jobidParam:Number, previewfolderParam:String = null, previewwidthParam:Number, previewheightParam:Number, previewformatParam:String = null, qualityParam:String = null, overprintpreviewParam:Boolean, pagesrangeParam:String = null):String
Generates the document content in XML representation.
Document
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
Document
 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.
Document
  
importAdobeSwatchbookSpotColor(nameParam:String = null):Color
Imports a spot color swatch from an Adobe color book.
Document
  
importDtd(fromParam:File = null):void
Imports a DTD to use for validation.
Document
  
importFormats(fromParam:File = null):void
Imports the cross reference formats from specified file.
Document
  
importStyles(formatParam:ImportFormat = null, fromParam:File = null, globalStrategyParam:GlobalClashResolutionStrategy = null):void
Imports the specified styles.
Document
  
importXML(fromParam:File = null):void
Imports the specified XML file into an InDesign document.
Document
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Document
 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
  
loadConditions(fromParam:File = null, loadConditionSetsParam:Boolean):void
Load conditions from the specified file.
Document
  
loadMasters(fromParam:File = null, globalStrategyForMasterPageParam:GlobalClashResolutionStrategyForMasterPage = null):void
Load masterpages from an InDesign file.
Document
  
loadSwatches(fromParam:File = null):void
Load swatches from the specified file.
Document
  
loadXMLTags(fromParam:File = null):void
Loads a set of XML markup tags from the specified file.
Document
  
Auto tag the document based on the style to tag mappings
Document
  
Auto style the document based on the tag to style mappings
Document
  
packageForPrint(toParam:File = null, copyingFontsParam:Boolean, copyingLinkedGraphicsParam:Boolean, copyingProfilesParam:Boolean, updatingGraphicsParam:Boolean, includingHiddenLayersParam:Boolean, ignorePreflightErrorsParam:Boolean, creatingReportParam:Boolean, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean
Packages the document.
Document
  
place(fileNameParam:Object = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):void
Place one or more files following the behavior of the place menu item.
Document
  
placeBuzzword(fileurlsParam:String = null, showingOptionsParam:Boolean = false, createLinkParam:Boolean = false, replaceSelectedParam:Boolean = true, applyGridParam:Boolean = false):void
Place the Buzzword document.
Document
  
print(printDialogParam:Boolean, usingParam:Object = null):void
Prints the Document(s).
Document
  
printBooklet(printBookletDialogParam:Boolean = false, usingParam:Object = null):void
Print the Booklet using current document and Booklet and Print settings in the document
Document
  
recompose():void
Recomposes the text in the Document.
Document
  
redo():void
Redoes the last action.
Document
  
removeEventListenerDocument(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Document
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Resets all the buttons to their Normal state.
Document
  
Resets all the multi-state objects to their first state.
Document
  
revert():Boolean
Reverts the document to its state at the last save operation.
Document
  
revertToProject(forceRevertParam:Boolean = false):void
Reverts to the version of the document in Version Cue.
Document
  
save(toParam:File = null, stationeryParam:Boolean = false, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Document
Save the document
Document
  
saveACopy(toParam:File = null, stationeryParam:Boolean = false):void
Saves a copy of the document.
Document
  
saveSwatches(toParam:File = null, swatchListParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves the specified swatch(es) to a swatchbook file.
Document
  
saveXMLTags(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves a set of tags to an external file.
Document
  
select(selectableItemsParam:Object = null, existingSelectionParam:SelectionOptions = null):void
Selects the specified object(s).
Document
  
synchronizeWithVersionCue(syncConflictResolutionParam:SyncConflictResolution = null, versionCommentsParam:String = null):VersionCueSyncStatus
Synchronizes the file with the Version Cue project.
Document
  
toSpecifier():String
Retrieves the object specifier.
Document
  
undo():void
Undoes the last action.
Document
  
Updates cross references' text source content in the document.
Document
 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
accurateLABSpotsproperty
accurateLABSpots:Boolean

If true, uses LAB alternates for spot colors when available.


Implementation
    public function get accurateLABSpots():Boolean
    public function set accurateLABSpots(value:Boolean):void
activeLayerproperty 
activeLayer:Layer

The active layer. Can also accept: String.


Implementation
    public function get activeLayer():Layer
    public function set activeLayer(value:Layer):void
activeProcessproperty 
activeProcess:PreflightProcess  [read-only]

The active preflight process for this document.


Implementation
    public function get activeProcess():PreflightProcess
AFTER_ACTIVATEproperty 
AFTER_ACTIVATE:String  [read-only]

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


Implementation
    public static function get AFTER_ACTIVATE():String
AFTER_EXPORTproperty 
AFTER_EXPORT:String  [read-only]

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


Implementation
    public static function get AFTER_EXPORT():String
AFTER_IMPORTproperty 
AFTER_IMPORT:String  [read-only]

Dispatched after importing a file into a Document. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_IMPORT():String
AFTER_LINKS_CHANGEDproperty 
AFTER_LINKS_CHANGED:String  [read-only]

Dispatched after one or more links in the Document have been added, deleted, or modified. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_LINKS_CHANGED():String
AFTER_NEWproperty 
AFTER_NEW:String  [read-only]

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


Implementation
    public static function get AFTER_NEW():String
AFTER_OPENproperty 
AFTER_OPEN:String  [read-only]

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


Implementation
    public static function get AFTER_OPEN():String
AFTER_PRINTproperty 
AFTER_PRINT:String  [read-only]

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


Implementation
    public static function get AFTER_PRINT():String
AFTER_REVERTproperty 
AFTER_REVERT:String  [read-only]

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


Implementation
    public static function get AFTER_REVERT():String
AFTER_SAVEproperty 
AFTER_SAVE:String  [read-only]

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


Implementation
    public static function get AFTER_SAVE():String
AFTER_SAVE_A_COPYproperty 
AFTER_SAVE_A_COPY:String  [read-only]

Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_SAVE_A_COPY():String
AFTER_SAVE_ASproperty 
AFTER_SAVE_AS:String  [read-only]

Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_SAVE_AS():String
afterBlendingIntentproperty 
afterBlendingIntent:RenderingIntent

The rendering intent for colors that result from transparency interactions on the page after blending.


Implementation
    public function get afterBlendingIntent():RenderingIntent
    public function set afterBlendingIntent(value:RenderingIntent):void
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
allGraphicsproperty 
allGraphics:Object  [read-only]

Lists all graphics contained by the Document.


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

All object styles contained by the Document.


Implementation
    public function get allObjectStyles():Object
allPageItemsproperty 
allPageItems:Object  [read-only]

Lists all page items contained by the Document.


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

Lists all paragraph styles (regardless of their group).


Implementation
    public function get allParagraphStyles():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
assignmentsproperty 
assignments:Assignments  [read-only]

A collection of assignments.


Implementation
    public function get assignments():Assignments
associatedXMLElementproperty 
associatedXMLElement:XMLItem  [read-only]

The XML element associated with the Document.


Implementation
    public function get associatedXMLElement():XMLItem
baselineFrameGridOptionsproperty 
baselineFrameGridOptions:BaselineFrameGridOption  [read-only]

Baseline frame grid option settings.


Implementation
    public function get baselineFrameGridOptions():BaselineFrameGridOption
BEFORE_CLOSEproperty 
BEFORE_CLOSE:String  [read-only]

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


Implementation
    public static function get BEFORE_CLOSE():String
BEFORE_DEACTIVATEproperty 
BEFORE_DEACTIVATE:String  [read-only]

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


Implementation
    public static function get BEFORE_DEACTIVATE():String
BEFORE_EXPORTproperty 
BEFORE_EXPORT:String  [read-only]

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


Implementation
    public static function get BEFORE_EXPORT():String
BEFORE_IMPORTproperty 
BEFORE_IMPORT:String  [read-only]

Dispatched before importing a file into a Document. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_IMPORT():String
BEFORE_PRINTproperty 
BEFORE_PRINT:String  [read-only]

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


Implementation
    public static function get BEFORE_PRINT():String
BEFORE_REVERTproperty 
BEFORE_REVERT:String  [read-only]

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


Implementation
    public static function get BEFORE_REVERT():String
BEFORE_SAVEproperty 
BEFORE_SAVE:String  [read-only]

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


Implementation
    public static function get BEFORE_SAVE():String
BEFORE_SAVE_A_COPYproperty 
BEFORE_SAVE_A_COPY:String  [read-only]

Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_SAVE_A_COPY():String
BEFORE_SAVE_ASproperty 
BEFORE_SAVE_AS:String  [read-only]

Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_SAVE_AS():String
bookmarksproperty 
bookmarks:Bookmarks  [read-only]

A collection of bookmarks.


Implementation
    public function get bookmarks():Bookmarks
buttonPreferencesproperty 
buttonPreferences:ButtonPreference  [read-only]

Button preference settings.


Implementation
    public function get buttonPreferences():ButtonPreference
buttonsproperty 
buttons:Buttons  [read-only]

A collection of buttons.


Implementation
    public function get buttons():Buttons
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
chapterNumberPreferencesproperty 
chapterNumberPreferences:ChapterNumberPreference  [read-only]

Chapter numbering preferences.


Implementation
    public function get chapterNumberPreferences():ChapterNumberPreference
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
cmykPolicyproperty 
cmykPolicy:ColorSettingsPolicy

The policy for handling colors in a CMYK color model, including reading and embedding color profiles, mismatches between embedded color profiles and the working space, and moving colors from one document to another.


Implementation
    public function get cmykPolicy():ColorSettingsPolicy
    public function set cmykPolicy(value:ColorSettingsPolicy):void
cmykProfileproperty 
cmykProfile:String

The current CMYK profile.


Implementation
    public function get cmykProfile():String
    public function set cmykProfile(value:String):void
cmykProfileListproperty 
cmykProfileList:Object  [read-only]

A list of valid CMYK profiles.


Implementation
    public function get cmykProfileList():Object
colorsproperty 
colors:Colors  [read-only]

A collection of colors.


Implementation
    public function get colors():Colors
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
convertedproperty 
converted:Boolean  [read-only]

If true, the Document was converted.


Implementation
    public function get converted():Boolean
crossReferenceFormatsproperty 
crossReferenceFormats:CrossReferenceFormats  [read-only]

A collection of cross reference formats.


Implementation
    public function get crossReferenceFormats():CrossReferenceFormats
crossReferenceSourcesproperty 
crossReferenceSources:CrossReferenceSources  [read-only]

A collection of cross reference text sources.


Implementation
    public function get crossReferenceSources():CrossReferenceSources
dashedStrokeStylesproperty 
dashedStrokeStyles:DashedStrokeStyles  [read-only]

A collection of dashed stroke styles.


Implementation
    public function get dashedStrokeStyles():DashedStrokeStyles
dataMergeImagePlaceholdersproperty 
dataMergeImagePlaceholders:DataMergeImagePlaceholders  [read-only]

A collection of data merge image placeholders.


Implementation
    public function get dataMergeImagePlaceholders():DataMergeImagePlaceholders
dataMergeOptionsproperty 
dataMergeOptions:DataMergeOption  [read-only]

The data merge option properties that define the data merge.


Implementation
    public function get dataMergeOptions():DataMergeOption
dataMergePropertiesproperty 
dataMergeProperties:DataMerge  [read-only]

Data merge properties that define data merge fields and preferences.


Implementation
    public function get dataMergeProperties():DataMerge
dataMergeTextPlaceholdersproperty 
dataMergeTextPlaceholders:DataMergeTextPlaceholders  [read-only]

A collection of data merge text placeholders.


Implementation
    public function get dataMergeTextPlaceholders():DataMergeTextPlaceholders
defaultImageIntentproperty 
defaultImageIntent:RenderingIntent

The rendering intent for bitmap images.


Implementation
    public function get defaultImageIntent():RenderingIntent
    public function set defaultImageIntent(value:RenderingIntent):void
dictionaryPreferencesproperty 
dictionaryPreferences:DictionaryPreference  [read-only]

User dictionary preference settings.


Implementation
    public function get dictionaryPreferences():DictionaryPreference
documentPreferencesproperty 
documentPreferences:DocumentPreference  [read-only]

Document preference settings.


Implementation
    public function get documentPreferences():DocumentPreference
dottedStrokeStylesproperty 
dottedStrokeStyles:DottedStrokeStyles  [read-only]

A collection of dotted stroke styles.


Implementation
    public function get dottedStrokeStyles():DottedStrokeStyles
dtdsproperty 
dtds:DTDs  [read-only]

A collection of DTDs.


Implementation
    public function get dtds():DTDs
editingStateproperty 
editingState:EditingState  [read-only]

The Version Cue editing state of the file.


Implementation
    public function get editingState():EditingState
epstextsproperty 
epstexts:EPSTexts  [read-only]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
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
exportForWebPreferencesproperty 
exportForWebPreferences:ExportForWebPreference  [read-only]

The default export for web preferences.


Implementation
    public function get exportForWebPreferences():ExportForWebPreference
FAILED_EXPORTproperty 
FAILED_EXPORT:String  [read-only]

Dispatched after a Document export is canceled or fails. This event bubbles. This event is not cancelable.


Implementation
    public static function get FAILED_EXPORT():String
filePathproperty 
filePath:File  [read-only]

The full path to the file.


Implementation
    public function get filePath():File
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
formFieldsproperty 
formFields:FormFields  [read-only]

A collection of form fields.


Implementation
    public function get formFields():FormFields
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 Document, including the name of the Document.


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

Galley preference settings.


Implementation
    public function get galleyPreferences():GalleyPreference
gradientsproperty 
gradients:Gradients  [read-only]

A collection of gradients.


Implementation
    public function get gradients():Gradients
graphicLinesproperty 
graphicLines:GraphicLines  [read-only]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
gridPreferencesproperty 
gridPreferences:GridPreference  [read-only]

Grid preference settings.


Implementation
    public function get gridPreferences():GridPreference
groupsproperty 
groups:Groups  [read-only]

A collection of groups.


Implementation
    public function get groups():Groups
guidePreferencesproperty 
guidePreferences:GuidePreference  [read-only]

Guide preference settings.


Implementation
    public function get guidePreferences():GuidePreference
guidesproperty 
guides:Guides  [read-only]

A collection of guides.


Implementation
    public function get guides():Guides
hyperlinkExternalPageDestinationsproperty 
hyperlinkExternalPageDestinations:HyperlinkExternalPageDestinations  [read-only]

A collection of hyperlink external page destinations.


Implementation
    public function get hyperlinkExternalPageDestinations():HyperlinkExternalPageDestinations
hyperlinkPageDestinationsproperty 
hyperlinkPageDestinations:HyperlinkPageDestinations  [read-only]

A collection of hyperlink page destinations.


Implementation
    public function get hyperlinkPageDestinations():HyperlinkPageDestinations
hyperlinkPageItemSourcesproperty 
hyperlinkPageItemSources:HyperlinkPageItemSources  [read-only]

A collection of hyperlink page item sources.


Implementation
    public function get hyperlinkPageItemSources():HyperlinkPageItemSources
hyperlinksproperty 
hyperlinks:Hyperlinks  [read-only]

A collection of hyperlinks.


Implementation
    public function get hyperlinks():Hyperlinks
hyperlinkTextDestinationsproperty 
hyperlinkTextDestinations:HyperlinkTextDestinations  [read-only]

A collection of hyperlink text destinations.


Implementation
    public function get hyperlinkTextDestinations():HyperlinkTextDestinations
hyperlinkTextSourcesproperty 
hyperlinkTextSources:HyperlinkTextSources  [read-only]

A collection of hyperlink text sources.


Implementation
    public function get hyperlinkTextSources():HyperlinkTextSources
hyperlinkURLDestinationsproperty 
hyperlinkURLDestinations:HyperlinkURLDestinations  [read-only]

A collection of hyperlink URL destinations.


Implementation
    public function get hyperlinkURLDestinations():HyperlinkURLDestinations
hyphenationExceptionsproperty 
hyphenationExceptions:HyphenationExceptions  [read-only]

A collection of hyphenation exceptions lists.


Implementation
    public function get hyphenationExceptions():HyphenationExceptions
idproperty 
id:Number  [read-only]

The unique ID of the Document.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the Document within its containing object.


Implementation
    public function get index():Number
indexesproperty 
indexes:Indexes  [read-only]

A collection of indexes.


Implementation
    public function get indexes():Indexes
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
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
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
languagesproperty 
languages:Languages  [read-only]

A collection of languages.


Implementation
    public function get languages():Languages
layersproperty 
layers:Layers  [read-only]

A collection of layers.


Implementation
    public function get layers():Layers
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
linksproperty 
links:Links  [read-only]

A collection of links.


Implementation
    public function get links():Links
marginPreferencesproperty 
marginPreferences:MarginPreference  [read-only]

Margin preference settings.


Implementation
    public function get marginPreferences():MarginPreference
masterSpreadsproperty 
masterSpreads:MasterSpreads  [read-only]

A collection of master spreads.


Implementation
    public function get masterSpreads():MasterSpreads
metadataPreferencesproperty 
metadataPreferences:MetadataPreference  [read-only]

Metadata preference settings.


Implementation
    public function get metadataPreferences():MetadataPreference
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
modifiedproperty 
modified:Boolean  [read-only]

If true, the Document has been modified since it was last saved.


Implementation
    public function get modified():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
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String  [read-only]

The name of the Document.


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

A collection of named grids.


Implementation
    public function get namedGrids():NamedGrids
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
ovalsproperty 
ovals:Ovals  [read-only]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageItemDefaultsproperty 
pageItemDefaults:PageItemDefault  [read-only]

The default page item formatting for the Document.


Implementation
    public function get pageItemDefaults():PageItemDefault
pageItemsproperty 
pageItems:PageItems  [read-only]

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.


Implementation
    public function get pageItems():PageItems
pagesproperty 
pages:Pages  [read-only]

A collection of pages.


Implementation
    public function get pages():Pages
paragraphDestinationsproperty 
paragraphDestinations:ParagraphDestinations  [read-only]

A collection of paragraph destinations.


Implementation
    public function get paragraphDestinations():ParagraphDestinations
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 Document (a Application).


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

Pasteboard preference settings.


Implementation
    public function get pasteboardPreferences():PasteboardPreference
placeGunsproperty 
placeGuns:PlaceGun  [read-only]

The place gun.


Implementation
    public function get placeGuns():PlaceGun
polygonsproperty 
polygons:Polygons  [read-only]

A collection of polygons.


Implementation
    public function get polygons():Polygons
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
preflightOptionsproperty 
preflightOptions:PreflightOption  [read-only]

Preflight option settings.


Implementation
    public function get preflightOptions():PreflightOption
preflightProfilesproperty 
preflightProfiles:PreflightProfiles  [read-only]

A collection of preflight profiles.


Implementation
    public function get preflightProfiles():PreflightProfiles
printBookletOptionsproperty 
printBookletOptions:PrintBookletOption  [read-only]

Booklet printing options.


Implementation
    public function get printBookletOptions():PrintBookletOption
printBookletPrintPreferencesproperty 
printBookletPrintPreferences:PrintBookletPrintPreference  [read-only]

Print booklet preferences.


Implementation
    public function get printBookletPrintPreferences():PrintBookletPrintPreference
printPreferencesproperty 
printPreferences:PrintPreference  [read-only]

Print preference settings.


Implementation
    public function get printPreferences():PrintPreference
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
readOnlyproperty 
readOnly:Boolean  [read-only]

If true, the Document is read-only.


Implementation
    public function get readOnly():Boolean
recoveredproperty 
recovered:Boolean  [read-only]

If true, the Document was recovered.


Implementation
    public function get recovered():Boolean
rectanglesproperty 
rectangles:Rectangles  [read-only]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
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
rgbPolicyproperty 
rgbPolicy:ColorSettingsPolicy

The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another.


Implementation
    public function get rgbPolicy():ColorSettingsPolicy
    public function set rgbPolicy(value:ColorSettingsPolicy):void
rgbProfileproperty 
rgbProfile:String

The current RGB profile.


Implementation
    public function get rgbProfile():String
    public function set rgbProfile(value:String):void
rgbProfileListproperty 
rgbProfileList:Object  [read-only]

A list of valid RGB profiles.


Implementation
    public function get rgbProfileList():Object
savedproperty 
saved:Boolean  [read-only]

If true, the Document has been saved since it was created.


Implementation
    public function get saved():Boolean
sectionsproperty 
sections:Sections  [read-only]

A collection of sections.


Implementation
    public function get sections():Sections
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
solidColorIntentproperty 
solidColorIntent:RenderingIntent

The rendering intent for all vector art (areas of solid color) in native objects.


Implementation
    public function get solidColorIntent():RenderingIntent
    public function set solidColorIntent(value:RenderingIntent):void
splineItemsproperty 
splineItems:SplineItems  [read-only]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
spreadsproperty 
spreads:Spreads  [read-only]

A collection of spreads.


Implementation
    public function get spreads():Spreads
storiesproperty 
stories:Stories  [read-only]

A collection of stories.


Implementation
    public function get stories():Stories
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
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
switchbackCommentDataproperty 
switchbackCommentData:String

The comment data to display (XML as string).


Implementation
    public function get switchbackCommentData():String
    public function set switchbackCommentData(value:String):void
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
textDefaultsproperty 
textDefaults:TextDefault  [read-only]

Text default settings.


Implementation
    public function get textDefaults():TextDefault
textFramePreferencesproperty 
textFramePreferences:TextFramePreference  [read-only]

Text frame preference settings.


Implementation
    public function get textFramePreferences():TextFramePreference
textFramesproperty 
textFrames:TextFrames  [read-only]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
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
tocStylesproperty 
tocStyles:TOCStyles  [read-only]

A collection of TOC styles.


Implementation
    public function get tocStyles():TOCStyles
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
validationErrorsproperty 
validationErrors:ValidationErrors  [read-only]

A collection of XML validation errors.


Implementation
    public function get validationErrors():ValidationErrors
versionStateproperty 
versionState:VersionState  [read-only]

The Version Cue version state of the file.


Implementation
    public function get versionState():VersionState
viewPreferencesproperty 
viewPreferences:ViewPreference  [read-only]

View preference settings.


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

If true, the Document 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
xmlCommentsproperty 
xmlComments:XMLComments  [read-only]

A collection of XML comments.


Implementation
    public function get xmlComments():XMLComments
xmlElementsproperty 
xmlElements:XMLElements  [read-only]

A collection of XML elements.


Implementation
    public function get xmlElements():XMLElements
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
xmlInstructionsproperty 
xmlInstructions:XMLInstructions  [read-only]

A collection of XML instructions.


Implementation
    public function get xmlInstructions():XMLInstructions
xmlItemsproperty 
xmlItems:XMLItems  [read-only]

A collection of XML items.


Implementation
    public function get xmlItems():XMLItems
xmlPreferencesproperty 
xmlPreferences:XMLPreference  [read-only]

The XML preference settings.


Implementation
    public function get xmlPreferences():XMLPreference
xmlStoriesproperty 
xmlStories:XmlStories  [read-only]

A collection of xml stories.


Implementation
    public function get xmlStories():XmlStories
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
zeroPointproperty 
zeroPoint:Object

The ruler origin, specified as page coordinates in the format [x, y].


Implementation
    public function get zeroPoint():Object
    public function set zeroPoint(value:Object):void
Method Detail
addEventListenerDocument()method
public function addEventListenerDocument(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
align()method 
public function align(alignDistributeItemsParam:Array = null, alignOptionParam:AlignOptions = null, alignDistributeBoundsParam:AlignDistributeBounds = null):void

Align page items.

Parameters

alignDistributeItemsParam:Array (default = null) — (Array) The page items to align or distribute.
 
alignOptionParam:AlignOptions (default = null) — (AlignOptions) The type of alignment to apply.
 
alignDistributeBoundsParam:AlignDistributeBounds (default = null) — (AlignDistributeBounds) The bounds within which to align or distribute the page items. (Optional)

asynchronousExportFile()method 
public function asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask

asynchronously exports the object(s) to a file.

Parameters

formatParam:Object (default = null) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
 
toParam:File (default = null) — (File) The path to the export file.
 
showingOptionsParam:Boolean (default = false) — (Boolean) If true, displays the export options dialog. (Optional)
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The export style. (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

Returns
BackgroundTask
changeComposer()method 
public function changeComposer():void

Change comoser to optyca

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
checkIn()method 
public function checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Check in to Version Cue.

Parameters

versionCommentsParam:String (default = null) — (String) The comment for this version (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) Forcibly save a version (Optional)

clearFrameFittingOptions()method 
public function clearFrameFittingOptions():void

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

close()method 
public function close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Close the Document

Parameters

savingParam:SaveOptions (default = null) — (SaveOptions) Whether to save changes before closing the Document (Optional)
 
savingInParam:File (default = null) — (File) The file in which to save the Document (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) Forcibly save a version (Optional)

createTOC()method 
public function createTOC(usingParam:TOCStyle = null, replacingParam:Boolean = false, fromBookParam:Book = null, placePointParam:Array = null, includeOversetParam:Boolean = false, destinationLayerParam:Layer = null):Object

Creates a table of contents.

Parameters

usingParam:TOCStyle (default = null) — (TOCStyle) The TOC style to use to define the content, title, and format of the table of contents.
 
replacingParam:Boolean (default = false) — (Boolean) If true, replaces the existing TOC. (Optional)
 
fromBookParam:Book (default = null) — (Book) The book whose documents to include in the TOC. (Optional)
 
placePointParam:Array (default = null) — (Array) The point at which to place the TOC story, specified as page coordinates in the format [x, y]. (Optional)
 
includeOversetParam:Boolean (default = false) — (Boolean) If true, includes overset text TOC entries in the TOC. (Optional)
 
destinationLayerParam:Layer (default = null) — (Layer) The layer on which to place the TOC. (Optional)

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

Deletes unused XML markup tags.

distribute()method 
public function distribute(alignDistributeItemsParam:Array = null, distributeOptionParam:DistributeOptions = null, alignDistributeBoundsParam:AlignDistributeBounds = null, useDistributeMeasurementParam:Boolean, absoluteDistributeMeasurementParam:Object = null):void

Distribute page items.

Parameters

alignDistributeItemsParam:Array (default = null) — (Array) The page items to align or distribute
 
distributeOptionParam:DistributeOptions (default = null) — (DistributeOptions) The type of distribution to apply.
 
alignDistributeBoundsParam:AlignDistributeBounds (default = null) — (AlignDistributeBounds) The bounds within which to align or distribute the page items. (Optional)
 
useDistributeMeasurementParam:Boolean (default = NaN) — (Boolean) If true, distribute space between page items. When this property is true, the bounds setting is ignored. (Optional)
 
absoluteDistributeMeasurementParam:Object (default = null) — (Object) The distance to use when distributing page items. (Optional)

embed()method 
public function embed(usingParam:Object = null):PreflightProfile

Embed this profile to the document.

Parameters

usingParam:Object (default = null) — (Object) The preflight profile to embed. Can accept: String or PreflightProfile.

Returns
PreflightProfile
exportFile()method 
public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Exports the object(s) to a file.

Parameters

formatParam:Object (default = null) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
 
toParam:File (default = null) — (File) The path to the export file.
 
showingOptionsParam:Boolean (default = false) — (Boolean) If true, displays the export options dialog. (Optional)
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The export style. (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves 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
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
generateDocContent()method 
public function generateDocContent(tasknameParam:String = null, reviewnameParam:String = null, jobidParam:Number, previewfolderParam:String = null, previewwidthParam:Number, previewheightParam:Number, previewformatParam:String = null, qualityParam:String = null, overprintpreviewParam:Boolean, pagesrangeParam:String = null):String

Generates the document content in XML representation.

Parameters

tasknameParam:String (default = null) — (String) Name used to identify the kind of background task
 
reviewnameParam:String (default = null) — (String) Specific review name reported by background tasks.
 
jobidParam:Number (default = NaN) — (Number) Unique identifier used to tag CSXSEvents.
 
previewfolderParam:String (default = null) — (String) Preview folder to cache preview images.
 
previewwidthParam:Number (default = NaN) — (Number) Preview width for the content.
 
previewheightParam:Number (default = NaN) — (Number) Preview height for the content.
 
previewformatParam:String (default = null) — (String) What formats to generate the previews in: 'jpg', 'png', or 'all'.
 
qualityParam:String (default = null) — (String) The quality for jpg previews: 'low', 'medium', 'high' or 'max'.
 
overprintpreviewParam:Boolean (default = NaN) — (Boolean) Whether to generate the preview with overprint preview turned on. (Optional)
 
pagesrangeParam:String (default = null) — (String) Pages range to generate content from. (Optional)

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
importDtd()method 
public function importDtd(fromParam:File = null):void

Imports a DTD to use for validation.

Parameters

fromParam:File (default = null) — (File) The path to the DTD file.

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

Imports the cross reference formats from specified file.

Parameters

fromParam:File (default = null) — (File) The file whose formats to import.

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)

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

Imports the specified XML file into an InDesign document.

Parameters

fromParam:File (default = null) — (File) The XML file.

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.

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)

loadMasters()method 
public function loadMasters(fromParam:File = null, globalStrategyForMasterPageParam:GlobalClashResolutionStrategyForMasterPage = null):void

Load masterpages from an InDesign file.

Parameters

fromParam:File (default = null) — (File) The InDesign file to load the masters from.
 
globalStrategyForMasterPageParam:GlobalClashResolutionStrategyForMasterPage (default = null) — (GlobalClashResolutionStrategyForMasterPage) the global clash resolution strategy for load master page (Optional)

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.

mapStylesToXMLTags()method 
public function mapStylesToXMLTags():void

Auto tag the document based on the style to tag mappings

mapXMLTagsToStyles()method 
public function mapXMLTagsToStyles():void

Auto style the document based on the tag to style mappings

packageForPrint()method 
public function packageForPrint(toParam:File = null, copyingFontsParam:Boolean, copyingLinkedGraphicsParam:Boolean, copyingProfilesParam:Boolean, updatingGraphicsParam:Boolean, includingHiddenLayersParam:Boolean, ignorePreflightErrorsParam:Boolean, creatingReportParam:Boolean, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean

Packages the document.

Parameters

toParam:File (default = null) — (File) The folder, alias, or path in which to place the packaged files.
 
copyingFontsParam:Boolean (default = NaN) — (Boolean) If true, copies fonts used in the document to the package folder.
 
copyingLinkedGraphicsParam:Boolean (default = NaN) — (Boolean) If true, copies linked graphics files to the package folder.
 
copyingProfilesParam:Boolean (default = NaN) — (Boolean) If true, copies color profiles to the package folder.
 
updatingGraphicsParam:Boolean (default = NaN) — (Boolean) If true, updates graphics links to the package folder.
 
includingHiddenLayersParam:Boolean (default = NaN) — (Boolean) If true, copies fonts and links from hidden layers to the package.
 
ignorePreflightErrorsParam:Boolean (default = NaN) — (Boolean) If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist.
 
creatingReportParam:Boolean (default = NaN) — (Boolean) If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information.
 
versionCommentsParam:String (default = null) — (String) The comments for the version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

Returns
Boolean
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)

placeBuzzword()method 
public function placeBuzzword(fileurlsParam:String = null, showingOptionsParam:Boolean = false, createLinkParam:Boolean = false, replaceSelectedParam:Boolean = true, applyGridParam:Boolean = false):void

Place the Buzzword document.

Parameters

fileurlsParam:String (default = null) — (String) Url strings to the buzzword files seperated by space.
 
showingOptionsParam:Boolean (default = false) — (Boolean) Whether to display the import options dialog. (Optional)
 
createLinkParam:Boolean (default = false) — (Boolean) Whether to create a link for the placed file. (Optional)
 
replaceSelectedParam:Boolean (default = true) — (Boolean) Whether to replace the selected item. (Optional)
 
applyGridParam:Boolean (default = false) — (Boolean) Whether to apply grid format for placed story. (Optional)

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

Prints the Document(s).

Parameters

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)

printBooklet()method 
public function printBooklet(printBookletDialogParam:Boolean = false, usingParam:Object = null):void

Print the Booklet using current document and Booklet and Print settings in the document

Parameters

printBookletDialogParam:Boolean (default = false) — (Boolean) Whether to invoke the print booklet dialog (Optional)
 
usingParam:Object (default = null) — (Object) Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

recompose()method 
public function recompose():void

Recomposes the text in the Document.

redo()method 
public function redo():void

Redoes the last action.

removeEventListenerDocument()method 
public function removeEventListenerDocument(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
resetAllButtons()method 
public function resetAllButtons():void

Resets all the buttons to their Normal state.

resetAllMultiStateObjects()method 
public function resetAllMultiStateObjects():void

Resets all the multi-state objects to their first state.

revert()method 
public function revert():Boolean

Reverts the document to its state at the last save operation.

Returns
Boolean
revertToProject()method 
public function revertToProject(forceRevertParam:Boolean = false):void

Reverts to the version of the document in Version Cue.

Parameters

forceRevertParam:Boolean (default = false) — (Boolean) Forcibly reverts to the project version. (Optional)

save()method 
public function save(toParam:File = null, stationeryParam:Boolean = false, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Document

Save the document

Parameters

toParam:File (default = null) — (File) Where to save the document. If the document is already saved, a copy is saved at this path, the original file is closed the new copy is opened (Optional)
 
stationeryParam:Boolean (default = false) — (Boolean) Whether to save the file as stationery (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) Forcibly save a version (Optional)

Returns
Document
saveACopy()method 
public function saveACopy(toParam:File = null, stationeryParam:Boolean = false):void

Saves a copy of the document.

Parameters

toParam:File (default = null) — (File) The file path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)
 
stationeryParam:Boolean (default = false) — (Boolean) If true, saves the file as stationery (Mac OS) or as a template (Windows). Note: The file extension for stationery and templates is different than the extension for regular files. (Optional)

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 Document in relation to previously selected objects. (Optional)

synchronizeWithVersionCue()method 
public function synchronizeWithVersionCue(syncConflictResolutionParam:SyncConflictResolution = null, versionCommentsParam:String = null):VersionCueSyncStatus

Synchronizes the file with the Version Cue project.

Parameters

syncConflictResolutionParam:SyncConflictResolution (default = null) — (SyncConflictResolution) The conflict resolution method to use during synchronization. (Optional)
 
versionCommentsParam:String (default = null) — (String) The comments that describe the version. (Optional)

Returns
VersionCueSyncStatus
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

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

Undoes the last action.

updateCrossReferences()method 
public function updateCrossReferences():void

Updates cross references' text source content in the document.