Document

A document.

Go to Property Listing | Method Listing

Methods:

addEventListener, adjustLayout, align, asynchronousExportFile, changeColor, changeComposer, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, checkIn, clearFrameFittingOptions, close, colorTransform, createAlternateLayout, createEmailQRCode, createHyperlinkQRCode, createMissingFontObject, createPlainTextQRCode, createTOC, createTextMsgQRCode, createVCardQRCode, deleteAlternateLayout, deleteUnusedTags, distribute, embed, exportFile, exportForCloudLibrary, exportPageItemsSelectionToSnippet, exportPageItemsToSnippet, exportStrokeStyles, extractLabel, findColor, findGlyph, findGrep, findObject, findText, findTransliterate, getAlternateLayoutsForFolio, getElements, getSelectedTextDirection, getStyleConflictResolutionStrategy, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importDtd, importFormats, importPdfComments, importStyles, importXML, insertLabel, internalMethod, loadConditions, loadMasters, loadSwatches, loadXMLTags, mapStylesToXMLTags, mapXMLTagsToStyles, packageForPrint, place, placeAndLink, placeCloudAsset, print, printBooklet, recompose, redo, removeEventListener, resetAllButtons, resetAllMultiStateObjects, revert, revertToProject, save, saveACopy, saveACopyCloud, saveAsCloud, saveSwatches, saveXMLTags, select, synchronizeWithVersionCue, toSource, toSpecifier, undo, updateCrossReferences

Objects:

AdjustLayoutPreference, AnchoredObjectDefault, AnchoredObjectSetting, Articles, Assignments, BaselineFrameGridOption, Bookmarks, Boolean, ButtonPreference, Buttons, CellStyle, CellStyleGroups, CellStyleMappings, CellStyles, ChapterNumberPreference, CharStyleMappings, CharacterStyle, CharacterStyleGroups, CharacterStyles, CheckBoxes, CjkGridPreference, ColorGroups, ColorSettingsPolicy, Colors, ComboBoxes, CompositeFonts, ConditionSets, ConditionalTextPreference, Conditions, CrossReferenceFormats, CrossReferenceSources, DTDs, DashedStrokeStyles, DataMerge, DataMergeImagePlaceholders, DataMergeOption, DataMergeQrcodePlaceholders, DataMergeTextPlaceholders, DictionaryPreference, DocumentPreference, DottedStrokeStyles, EPSTexts, EPubExportPreference, EPubFixedLayoutExportPreference, EditingState, EndnoteOption, EndnoteTextFrames, EventListeners, Events, ExportForWebPreference, File, Fonts, FootnoteOption, FormFields, FrameFittingOption, GalleyPreference, Gradients, Graphic, GraphicLines, GridPreference, Groups, GuidePreference, Guides, HTMLExportPreference, HTMLFXLExportPreference, HyperlinkExternalPageDestinations, HyperlinkPageDestinations, HyperlinkPageItemSources, HyperlinkTextDestinations, HyperlinkTextSources, HyperlinkURLDestinations, Hyperlinks, HyphenationExceptions, IndexOptions, Indexes, IndexingSortOptions, Inks, KinsokuTables, Languages, Layer, Layers, LayoutGridDataInformation, LayoutWindows, LinkedPageItemOption, LinkedStoryOption, Links, ListBoxes, MarginPreference, MasterSpreads, MetadataPreference, MixedInkGroups, MixedInks, MojikumiTables, MojikumiUiPreference, MotionPresets, MultiStateObjects, NamedGrids, NothingEnum, Number, NumberingLists, Object, ObjectStyle, ObjectStyleGroups, ObjectStyles, Ovals, PDFComments, PageItem, PageItemDefault, PageItems, Pages, ParaStyleMappings, ParagraphDestinations, ParagraphStyle, ParagraphStyleGroups, ParagraphStyles, PasteboardPreference, PlaceGun, Polygons, Preferences, PreflightOption, PreflightProcess, PreflightProfiles, PrintBookletOption, PrintBookletPrintPreference, PrintPreference, PublishExportPreference, RadioButtons, Rectangles, RenderingIntent, Sections, SignatureFields, SplineItems, Spreads, Stories, StoryGridDataInformation, StoryPreference, StoryWindows, String, StripedStrokeStyles, StrokeStyles, Swatch, Swatches, TOCStyles, TableStyle, TableStyleGroups, TableStyleMappings, TableStyles, TaggedPDFPreference, TextBoxes, TextDefault, TextFramePreference, TextFrames, TextPreference, TextVariables, TextWrapPreference, Tints, TransparencyPreference, TrapPresets, ValidationErrors, VersionState, ViewPreference, WatermarkPreference, Windows, XMLComments, XMLElements, XMLExportMaps, XMLExportPreference, XMLImportMaps, XMLImportPreference, XMLInstructions, XMLItem, XMLItems, XMLPreference, XMLTags, XMLViewPreference, XmlStories

Preferences:

AdjustLayoutPreference, BaselineFrameGridOption, ButtonPreference, ChapterNumberPreference, CjkGridPreference, ConditionalTextPreference, DataMergeOption, DictionaryPreference, DocumentPreference, EPubExportPreference, EPubFixedLayoutExportPreference, EndnoteOption, ExportForWebPreference, FootnoteOption, FrameFittingOption, GalleyPreference, GridPreference, GuidePreference, HTMLExportPreference, HTMLFXLExportPreference, HyphenationExceptions, IndexOptions, IndexingSortOptions, LinkedPageItemOption, LinkedStoryOption, MarginPreference, MetadataPreference, MojikumiUiPreference, PasteboardPreference, Preferences, PreflightOption, PrintBookletOption, PrintBookletPrintPreference, PrintPreference, PublishExportPreference, StoryPreference, TaggedPDFPreference, TextFramePreference, TextPreference, TextWrapPreference, TransparencyPreference, ViewPreference, WatermarkPreference, XMLExportPreference, XMLImportPreference, XMLPreference, XMLViewPreference

Property Listing

Property

Type

Access

Description

accurateLABSpots

Boolean

read/write

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

activeLayer

Layer

String

read/write

The active layer. Can also accept: String.

activeProcess

PreflightProcess

readonly

The active preflight process for this document.

adjustLayoutPreferences

AdjustLayoutPreference

readonly

Adjust layout preference settings.

afterBlendingIntent

RenderingIntent

RenderingIntent.ABSOLUTE_COLORIMETRIC

RenderingIntent.PERCEPTUAL

RenderingIntent.RELATIVE_COLORIMETRIC

RenderingIntent.SATURATION

RenderingIntent.USE_COLOR_SETTINGS

read/write

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

allCellStyles

Array of CellStyle

readonly

All Cell styles

allCharacterStyles

Array of CharacterStyle

readonly

Lists all character styles (regardless of their group).

allGraphics

Array of Graphic

readonly

Lists all graphics contained by the Document.

allObjectStyles

Array of ObjectStyle

readonly

All object styles contained by the Document.

allPageItems

Array of PageItem

readonly

Lists all page items contained by the Document.

allParagraphStyles

Array of ParagraphStyle

readonly

Lists all paragraph styles (regardless of their group).

allTableStyles

Array of TableStyle

readonly

All Table styles

anchoredObjectDefaults

AnchoredObjectDefault

readonly

Anchored object default settings.

anchoredObjectSettings

AnchoredObjectSetting

readonly

Anchored object settings.

articles

Articles Article

readonly

A collection of articles.

assignments

Assignments Assignment

readonly

A collection of assignments.

associatedXMLElement

XMLItem

readonly

The XML element associated with the Document.

baselineFrameGridOptions

BaselineFrameGridOption

readonly

Baseline frame grid option settings.

bookmarks

Bookmarks Bookmark

readonly

A collection of bookmarks.

buttonPreferences

ButtonPreference

readonly

Button preference settings.

buttons

Buttons Button

readonly

A collection of buttons.

cellStyleGroups

CellStyleGroups CellStyleGroup

readonly

A collection of cell style groups.

cellStyleMappings

CellStyleMappings CellStyleMapping

readonly

A collection of cell style mappings.

cellStyles

CellStyles CellStyle

readonly

A collection of cell styles.

chapterNumberPreferences

ChapterNumberPreference

readonly

Chapter numbering preferences.

charStyleMappings

CharStyleMappings CharStyleMapping

readonly

A collection of char style mappings.

characterStyleGroups

CharacterStyleGroups CharacterStyleGroup

readonly

A collection of character style groups.

characterStyles

CharacterStyles CharacterStyle

readonly

A collection of character styles.

checkBoxes

CheckBoxes

readonly

A collection of checkboxes.

cjkGridPreferences

CjkGridPreference

readonly

CJK grid preference settings.

cloudPath

String

readonly

The cloud path in case of a cloud document. Otherwise it throws error.

cmykPolicy

ColorSettingsPolicy

ColorSettingsPolicy.COLOR_POLICY_OFF

ColorSettingsPolicy.COMBINATION_OF_PRESERVE_AND_SAFE_CMYK

ColorSettingsPolicy.CONVERT_TO_WORKING_SPACE

ColorSettingsPolicy.PRESERVE_EMBEDDED_PROFILES

read/write

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.

cmykProfile

String

read/write

The current CMYK profile.

cmykProfileList

Array of String

readonly

A list of valid CMYK profiles.

colorGroups

ColorGroups ColorGroup

readonly

A collection of color groups.

colors

Colors Color

readonly

A collection of colors.

comboBoxes

ComboBoxes

readonly

A collection of comboboxes.

compositeFonts

CompositeFonts CompositeFont

readonly

A collection of composite fonts.

conditionSets

ConditionSets ConditionSet

readonly

A collection of condition sets for conditional text.

conditionalTextPreferences

ConditionalTextPreference

readonly

Conditional text preferences.

conditions

Conditions Condition

readonly

A collection of conditions for conditional text.

converted

Boolean

readonly

If true, the Document was converted.

crossReferenceFormats

CrossReferenceFormats CrossReferenceFormat

readonly

A collection of cross reference formats.

crossReferenceSources

CrossReferenceSources CrossReferenceSource

readonly

A collection of cross reference text sources.

dashedStrokeStyles

DashedStrokeStyles DashedStrokeStyle

readonly

A collection of dashed stroke styles.

dataMergeImagePlaceholders

DataMergeImagePlaceholders DataMergeImagePlaceholder

readonly

A collection of data merge image placeholders.

dataMergeOptions

DataMergeOption

readonly

The data merge option properties that define the data merge.

dataMergeProperties

DataMerge

readonly

Data merge properties that define data merge fields and preferences.

dataMergeQrcodePlaceholders

DataMergeQrcodePlaceholders DataMergeQrcodePlaceholder

readonly

A collection of data merge QR code placeholders.

dataMergeTextPlaceholders

DataMergeTextPlaceholders DataMergeTextPlaceholder

readonly

A collection of data merge text placeholders.

defaultImageIntent

RenderingIntent

RenderingIntent.ABSOLUTE_COLORIMETRIC

RenderingIntent.PERCEPTUAL

RenderingIntent.RELATIVE_COLORIMETRIC

RenderingIntent.SATURATION

RenderingIntent.USE_COLOR_SETTINGS

read/write

The rendering intent for bitmap images.

dictionaryPreferences

DictionaryPreference

readonly

User dictionary preference settings.

documentPreferences

DocumentPreference

readonly

Document preference settings.

dottedStrokeStyles

DottedStrokeStyles DottedStrokeStyle

readonly

A collection of dotted stroke styles.

dtds

DTDs DTD

readonly

A collection of DTDs.

editingState

EditingState

EditingState.EDITING_CONFLICT

EditingState.EDITING_LOCALLY

EditingState.EDITING_LOCALLY_LOCKED

EditingState.EDITING_NOWHERE

EditingState.EDITING_REMOTELY

EditingState.EDITING_UNKNOWN

readonly

The Version Cue editing state of the file.

endnoteOptions

EndnoteOption

readonly

Endnote option settings.

endnoteTextFrames

EndnoteTextFrames EndnoteTextFrame

readonly

A collection of endnote text frames.

epstexts

EPSTexts EPSText

readonly

EPSTexts

epubExportPreferences

EPubExportPreference

readonly

EPub export preference settings.

epubFixedLayoutExportPreferences

EPubFixedLayoutExportPreference

readonly

EPub fixed layout export preference settings.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

exportForWebPreferences

ExportForWebPreference

readonly

The default export for web preferences.

filePath

File

readonly

The full path to the file.

fonts

Fonts Font

readonly

A collection of fonts.

footnoteOptions

FootnoteOption

readonly

Footnote option settings.

formFields

FormFields FormField

readonly

A collection of form fields.

frameFittingOptions

FrameFittingOption

readonly

The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.

fullName

File

readonly

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

galleyPreferences

GalleyPreference

readonly

Galley preference settings.

gradients

Gradients Gradient

readonly

A collection of gradients.

graphicLines

GraphicLines GraphicLine

readonly

A collection of graphic lines.

gridPreferences

GridPreference

readonly

Grid preference settings.

groups

Groups Group

readonly

A collection of groups.

guidePreferences

GuidePreference

readonly

Guide preference settings.

guides

Guides Guide

readonly

A collection of guides.

htmlExportPreferences

HTMLExportPreference

readonly

HTML export preference settings.

htmlFXLExportPreferences

HTMLFXLExportPreference

readonly

HTML FXL export preference settings.

hyperlinkExternalPageDestinations

HyperlinkExternalPageDestinations HyperlinkExternalPageDestination

readonly

A collection of hyperlink external page destinations.

hyperlinkPageDestinations

HyperlinkPageDestinations HyperlinkPageDestination

readonly

A collection of hyperlink page destinations.

hyperlinkPageItemSources

HyperlinkPageItemSources HyperlinkPageItemSource

readonly

A collection of hyperlink page item sources.

hyperlinkTextDestinations

HyperlinkTextDestinations HyperlinkTextDestination

readonly

A collection of hyperlink text destinations.

hyperlinkTextSources

HyperlinkTextSources HyperlinkTextSource

readonly

A collection of hyperlink text sources.

hyperlinkURLDestinations

HyperlinkURLDestinations HyperlinkURLDestination

readonly

A collection of hyperlink URL destinations.

hyperlinks

Hyperlinks Hyperlink

readonly

A collection of hyperlinks.

hyphenationExceptions

HyphenationExceptions HyphenationException

readonly

A collection of hyphenation exceptions lists.

id

Number

readonly

The unique ID of the Document.

index

Number

readonly

The index of the Document within its containing object.

indexGenerationOptions

IndexOptions

readonly

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

indexes

Indexes

readonly

A collection of indexes.

indexingSortOptions

IndexingSortOptions IndexingSortOption

readonly

A collection of indexing sort options.

inks

Inks Ink

readonly

A collection of inks.

isCloudDocument

Boolean

readonly

If true, the document is a cloud document.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

kinsokuTables

KinsokuTables KinsokuTable

readonly

A collection of kinsoku tables.

label

String

read/write

A property that can be set to any string.

languages

Languages Language

readonly

A collection of languages.

layers

Layers Layer

readonly

A collection of layers.

layoutGridData

LayoutGridDataInformation

readonly

Default properties specific to layout grids.

layoutWindows

LayoutWindows LayoutWindow

readonly

A collection of layout windows.

linkedPageItemOptions

LinkedPageItemOption

readonly

Linked Page Item options

linkedStoryOptions

LinkedStoryOption

readonly

Linked story options

links

Links Link

readonly

A collection of links.

listBoxes

ListBoxes

readonly

A collection of listboxes.

marginPreferences

MarginPreference

readonly

Margin preference settings.

masterSpreads

MasterSpreads MasterSpread

readonly

A collection of master spreads.

metadataPreferences

MetadataPreference

readonly

Metadata preference settings.

mixedInkGroups

MixedInkGroups MixedInkGroup

readonly

A collection of mixed ink groups.

mixedInks

MixedInks MixedInk

readonly

A collection of mixed inks.

modified

Boolean

readonly

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

mojikumiTables

MojikumiTables MojikumiTable

readonly

A collection of mojikumi tables.

mojikumiUIPreferences

MojikumiUiPreference

readonly

Mojikumi user interface preference settings.

motionPresets

MotionPresets MotionPreset

readonly

A collection of Motion presets.

multiStateObjects

MultiStateObjects MultiStateObject

readonly

A collection of multi-state objects.

name

String

read/write

The name of the Document.

namedGrids

NamedGrids NamedGrid

readonly

A collection of named grids.

numberingLists

NumberingLists NumberingList

readonly

A collection of numbered lists.

objectStyleGroups

ObjectStyleGroups ObjectStyleGroup

readonly

A collection of object style groups.

objectStyles

ObjectStyles ObjectStyle

readonly

A collection of object styles.

ovals

Ovals Oval

readonly

A collection of ellipses.

pageItemDefaults

PageItemDefault

readonly

The default page item formatting for the Document.

pageItems

PageItems PageItem

readonly

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.

pages

Pages Page

readonly

A collection of pages.

paraStyleMappings

ParaStyleMappings ParaStyleMapping

readonly

A collection of para style mappings.

paragraphDestinations

ParagraphDestinations ParagraphDestination

readonly

A collection of paragraph destinations.

paragraphStyleGroups

ParagraphStyleGroups ParagraphStyleGroup

readonly

A collection of paragraph style groups.

paragraphStyles

ParagraphStyles ParagraphStyle

readonly

A collection of paragraph styles.

parent

Application

readonly

The parent of the Document (a Application).

pasteboardPreferences

PasteboardPreference

readonly

Pasteboard preference settings.

pdfComments

PDFComments PDFComment

readonly

A collection of PDF comment objects

placeGuns

PlaceGun

readonly

The place gun.

polygons

Polygons Polygon

readonly

A collection of polygons.

preferences

Preferences Preference

readonly

A collection of preferences objects.

preflightOptions

PreflightOption

readonly

Preflight option settings.

preflightProfiles

PreflightProfiles PreflightProfile

readonly

A collection of preflight profiles.

printBookletOptions

PrintBookletOption

readonly

Booklet printing options.

printBookletPrintPreferences

PrintBookletPrintPreference

readonly

Print booklet preferences.

printPreferences

PrintPreference

readonly

Print preference settings.

properties

Object

read/write

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

publishExportPreferences

PublishExportPreference

readonly

Publish export preference settings.

radioButtons

RadioButtons RadioButton

readonly

A collection of radio buttons.

readOnly

Boolean

readonly

If true, the Document is read-only.

recovered

Boolean

readonly

If true, the Document was recovered.

rectangles

Rectangles Rectangle

readonly

A collection of rectangles.

redoHistory

Array of String

readonly

The names of the items in the redo stack.

redoName

String

readonly

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

rgbPolicy

ColorSettingsPolicy

ColorSettingsPolicy.COLOR_POLICY_OFF

ColorSettingsPolicy.COMBINATION_OF_PRESERVE_AND_SAFE_CMYK

ColorSettingsPolicy.CONVERT_TO_WORKING_SPACE

ColorSettingsPolicy.PRESERVE_EMBEDDED_PROFILES

read/write

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.

rgbProfile

String

read/write

The current RGB profile.

rgbProfileList

Array of String

readonly

A list of valid RGB profiles.

saved

Boolean

readonly

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

sections

Sections Section

readonly

A collection of sections.

selectedPageItems

Array of Object

NothingEnum.NOTHING

readonly

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

selection

Array of Object

NothingEnum.NOTHING

read/write

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

selectionKeyObject

PageItem

NothingEnum.NOTHING

read/write

The key object of the selection. Can also accept: NothingEnum enumerator.

signatureFields

SignatureFields SignatureField

readonly

A collection of signature fields.

solidColorIntent

RenderingIntent

RenderingIntent.ABSOLUTE_COLORIMETRIC

RenderingIntent.PERCEPTUAL

RenderingIntent.RELATIVE_COLORIMETRIC

RenderingIntent.SATURATION

RenderingIntent.USE_COLOR_SETTINGS

read/write

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

splineItems

SplineItems SplineItem

readonly

The spline items collection.

spreads

Spreads Spread

readonly

A collection of spreads.

stories

Stories Story

readonly

A collection of stories.

storyGridData

StoryGridDataInformation

readonly

Default properties specific to frame grids.

storyPreferences

StoryPreference

readonly

Story preference settings.

storyWindows

StoryWindows StoryWindow

readonly

A collection of story windows.

stripedStrokeStyles

StripedStrokeStyles StripedStrokeStyle

readonly

A collection of striped stroke styles.

strokeStyles

StrokeStyles StrokeStyle

readonly

A collection of stroke styles.

swatches

Swatches

readonly

A collection of swatches.

tableStyleGroups

TableStyleGroups TableStyleGroup

readonly

A collection of table style groups.

tableStyleMappings

TableStyleMappings TableStyleMapping

readonly

A collection of table style mappings.

tableStyles

TableStyles TableStyle

readonly

A collection of table styles.

taggedPDFPreferences

TaggedPDFPreference

readonly

Tagged PDF preferences.

textBoxes

TextBoxes

readonly

A collection of text boxes.

textDefaults

TextDefault

readonly

Text default settings.

textFramePreferences

TextFramePreference

readonly

Text frame preference settings.

textFrames

TextFrames TextFrame

readonly

A collection of text frames.

textPreferences

TextPreference

readonly

Text preference settings.

textVariables

TextVariables TextVariable

readonly

A collection of text variables.

textWrapPreferences

TextWrapPreference

readonly

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

tints

Tints Tint

readonly

A collection of tints.

tocStyles

TOCStyles TOCStyle

readonly

A collection of TOC styles.

transparencyPreferences

TransparencyPreference

readonly

Transparency preference settings.

trapPresets

TrapPresets TrapPreset

readonly

A collection of trap presets.

undoHistory

Array of String

readonly

The names of the items in the undo stack.

undoName

String

readonly

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

unusedSwatches

Array of Swatch

readonly

The swatches that are not being used.

validationErrors

ValidationErrors ValidationError

readonly

A collection of XML validation errors.

versionState

VersionState

VersionState.LOCAL_NEWER

VersionState.LOCAL_PROJECT_MATCH

VersionState.NO_RESOURCE

VersionState.PROJECT_FILE_NEWER

VersionState.VERSION_CONFLICT

VersionState.VERSION_UNKNOWN

readonly

The Version Cue version state of the file.

viewPreferences

ViewPreference

readonly

View preference settings.

visible

Boolean

readonly

If true, the Document is visible.

watermarkPreferences

WatermarkPreference

readonly

Watermark preferences

windows

Windows Window

readonly

A collection of windows.

xmlComments

XMLComments XMLComment

readonly

A collection of XML comments.

xmlElements

XMLElements XMLElement

readonly

A collection of XML elements.

xmlExportMaps

XMLExportMaps XMLExportMap

readonly

A collection of XML export maps.

xmlExportPreferences

XMLExportPreference

readonly

XML export preference settings.

xmlImportMaps

XMLImportMaps XMLImportMap

readonly

A collection of XML import maps.

xmlImportPreferences

XMLImportPreference

readonly

XML import preference settings.

xmlInstructions

XMLInstructions XMLInstruction

readonly

A collection of XML instructions.

xmlItems

XMLItems XMLItem

readonly

A collection of XML items.

xmlPreferences

XMLPreference

readonly

The XML preference settings.

xmlStories

XmlStories XmlStory

readonly

A collection of xml stories.

xmlTags

XMLTags XMLTag

readonly

A collection of XML tags.

xmlViewPreferences

XMLViewPreference

readonly

XML view preference settings.

zeroPoint

Array of Number

Array of String

read/write

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

Constants/Events

Name

Type

Access

Description

AFTER_ACTIVATE

String

readonly

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

AFTER_EXPORT

String

readonly

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

AFTER_IMPORT

String

readonly

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

AFTER_LINKS_CHANGED

String

readonly

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

AFTER_NEW

String

readonly

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

AFTER_OPEN

String

readonly

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

AFTER_PRINT

String

readonly

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

AFTER_REVERT

String

readonly

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

AFTER_SAVE

String

readonly

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

AFTER_SAVE_AS

String

readonly

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

AFTER_SAVE_A_COPY

String

readonly

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

BEFORE_CLOSE

String

readonly

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

BEFORE_DEACTIVATE

String

readonly

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

BEFORE_EXPORT

String

readonly

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

BEFORE_IMPORT

String

readonly

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

BEFORE_PRINT

String

readonly

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

BEFORE_REVERT

String

readonly

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

BEFORE_SAVE

String

readonly

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

BEFORE_SAVE_AS

String

readonly

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

BEFORE_SAVE_A_COPY

String

readonly

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

FAILED_EXPORT

String

readonly

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

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined adjustLayout (adoptTo:Object, affectedPages:Array of Page)

Adjust the existing layout according to new page size, bleed and margin values. The first parameter is a plain object with key value pairs for properties affected. Permissible keys are width, height, bleedInside, bleedTop, bleedOutside, bleedBottom, leftMargin, topMargin, rightMargin, bottomMargin. The values can be specified as decimal numbers in units of Pt or as a string having a measurement value such as '1 in'. Not all properties need to be specified, only the values that need updation. Notice that when dealing with individual pages rather than the whole document, bleed changes has no effect. E.g. - app.activeDocument.adjustLayout({width:'600px', leftMargin: '1in'}), app.activeDocument.adjustLayout({rightMargin:'1in'}, app.activeDocument.spreads[0].pages), app.activeDocument.spreads[0].pages[0].adjustLayout({width:'400px', leftMargin: '10px'})

Parameter

Type

Description

adoptTo

Object

Change values - see functin definition for details

affectedPages

Array of Page

The collection of Page objects to affect (optional). Has no effect if function is called from Page (Optional)

undefined align (alignDistributeItems:Array of PageItem, alignOption:AlignOptions, alignDistributeBounds:AlignDistributeBounds, reference:PageItem)

Align page items.

Parameter

Type

Description

alignDistributeItems

Array of PageItem

The page items to align or distribute.

alignOption

AlignOptions

AlignOptions.BOTTOM_EDGES

AlignOptions.HORIZONTAL_CENTERS

AlignOptions.LEFT_EDGES

AlignOptions.RIGHT_EDGES

AlignOptions.TOP_EDGES

AlignOptions.VERTICAL_CENTERS

The type of alignment to apply.

alignDistributeBounds

AlignDistributeBounds

AlignDistributeBounds.ITEM_BOUNDS

AlignDistributeBounds.KEY_OBJECT

AlignDistributeBounds.MARGIN_BOUNDS

AlignDistributeBounds.PAGE_BOUNDS

AlignDistributeBounds.SPREAD_BOUNDS

The bounds within which to align or distribute the page items. (Optional)

reference

PageItem

The reference or key object to align to distribute relative to. Required when 'align distribute bounds' specifies 'key object'. (Optional)

BackgroundTask asynchronousExportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

asynchronously exports the object(s) to a file.

Parameter

Type

Description

format

ExportFormat

ExportFormat.EPS_TYPE

ExportFormat.EPUB

ExportFormat.FIXED_LAYOUT_EPUB

ExportFormat.HTML

ExportFormat.HTMLFXL

ExportFormat.INCOPY_MARKUP

ExportFormat.INDESIGN_MARKUP

ExportFormat.INDESIGN_SNIPPET

ExportFormat.INTERACTIVE_PDF

ExportFormat.JPG

ExportFormat.PDF_TYPE

ExportFormat.PNG_FORMAT

ExportFormat.RTF

ExportFormat.TAGGED_TEXT

ExportFormat.TEXT_TYPE

ExportFormat.XML

String

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.

to

File

The path to the export file.

showingOptions

Boolean

If true, displays the export options dialog. (Optional)

(default: false)

using

PDFExportPreset

The export style. (Optional)

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

Number changeColor ()

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

undefined changeComposer ()

Change comoser to optyca

Text changeGlyph (reverseOrder:Boolean)

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

Parameter

Type

Description

reverseOrder

Boolean

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

Text changeGrep (reverseOrder:Boolean)

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

Parameter

Type

Description

reverseOrder

Boolean

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

PageItem changeObject (reverseOrder:Boolean)

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

Parameter

Type

Description

reverseOrder

Boolean

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

Text changeText (reverseOrder:Boolean)

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

Parameter

Type

Description

reverseOrder

Boolean

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

Text changeTransliterate (reverseOrder:Boolean)

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

Parameter

Type

Description

reverseOrder

Boolean

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

undefined checkIn (versionComments:String, [forceSave:Boolean=Boolean])

Check in to Version Cue.

Parameter

Type

Description

versionComments

String

The comment for this version (Optional)

forceSave

Boolean

Forcibly save a version (Optional)

(default: false)

undefined clearFrameFittingOptions ()

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

undefined close ([saving:SaveOptions=SaveOptions], savingIn:File, versionComments:String, [forceSave:Boolean=Boolean])

Close the Document

Parameter

Type

Description

saving

SaveOptions

SaveOptions.ASK

SaveOptions.NO

SaveOptions.YES

Whether to save changes before closing the Document (Optional)

(default: SaveOptions.ASK)

savingIn

File

The file in which to save the Document (Optional)

versionComments

String

The comment for this version (Optional)

forceSave

Boolean

Forcibly save a version (Optional)

(default: false)

Number colorTransform (colorValue:Array of Number, sourceColorSpace:ColorSpace, destinationColorSpace:ColorSpace)

Transforms color values

Parameter

Type

Description

colorValue

Array of Number

source color value

sourceColorSpace

ColorSpace

ColorSpace.CMYK

ColorSpace.HSB

ColorSpace.LAB

ColorSpace.MIXEDINK

ColorSpace.RGB

source color space

destinationColorSpace

ColorSpace

ColorSpace.CMYK

ColorSpace.HSB

ColorSpace.LAB

ColorSpace.MIXEDINK

ColorSpace.RGB

destination color space

undefined createAlternateLayout (spreadItems:Array of Spread, name:String, width:Number String, height:Number String, createTextStyles:Boolean, linkTextStories:Boolean, layoutRule:LayoutRuleOptions)

Creates an alternate layout for a given list of spreads.

Parameter

Type

Description

spreadItems

Array of Spread

The spreads to create an alternate layout for.

name

String

The name of the alternate layout. Note: This is used for the named layout for the new section for the duplicated spreads.

width

Number

String

The width of the pages created.

height

Number

String

The height of the pages created.

createTextStyles

Boolean

Whether to create new text styles.

linkTextStories

Boolean

Whether to create linked text for duplicated text stories.

layoutRule

LayoutRuleOptions

LayoutRuleOptions.GUIDE_BASED

LayoutRuleOptions.OBJECT_BASED

LayoutRuleOptions.OFF

LayoutRuleOptions.PRESERVE_EXISTING

LayoutRuleOptions.RECENTER

LayoutRuleOptions.SCALE

LayoutRuleOptions.USE_MASTER

What layout rule to set on the pages.

undefined createEmailQRCode (emailAddress:String, subject:String, body:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Email QR Code on the page item or document

Parameter

Type

Description

emailAddress

String

QR code Email Address (Optional)

subject

String

QR code Email Subject (Optional)

body

String

QR code Email Body Message (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)

undefined createHyperlinkQRCode (urlLink:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Hyperlink QR Code on the page item or document

Parameter

Type

Description

urlLink

String

QR code Hyperlink URL (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)

Font createMissingFontObject (fontFamily:String, fontStyleName:String, postscriptName:String)

Create a missing font object.

Parameter

Type

Description

fontFamily

String

The name of the font family

fontStyleName

String

The name of the font style.

postscriptName

String

The PostScript name of the font.

undefined createPlainTextQRCode (plainText:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Plain Text QR Code on the page item

Parameter

Type

Description

plainText

String

QR code Plain Text (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)

Story createTOC (using:TOCStyle, [replacing:Boolean=Boolean], fromBook:Book, placePoint:Array of Number String, [includeOverset:Boolean=Boolean], destinationLayer:Layer)

Creates a table of contents.

Parameter

Type

Description

using

TOCStyle

The TOC style to use to define the content, title, and format of the table of contents.

replacing

Boolean

If true, replaces the existing TOC. (Optional)

(default: false)

fromBook

Book

The book whose documents to include in the TOC. (Optional)

placePoint

Array of Number

Array of String

The point at which to place the TOC story, specified as page coordinates in the format [x, y]. (Optional)

includeOverset

Boolean

If true, includes overset text TOC entries in the TOC. (Optional)

(default: false)

destinationLayer

Layer

The layer on which to place the TOC. (Optional)

undefined createTextMsgQRCode (cellNumber:String, textMessage:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Text Msg QR Code on the page item or document

Parameter

Type

Description

cellNumber

String

QR code Text Phone Number (Optional)

textMessage

String

QR code Text Message (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)

undefined createVCardQRCode (firstName:String, lastName:String, jobTitle:String, cellPhone:String, phone:String, email:String, organisation:String, streetAddress:String, city:String, adrState:String, country:String, postalCode:String, website:String, qrCodeSwatch:Varies Swatch String, withProperties:Array of String)

Create Business Card QR Code on the page item or load on document's placegun

Parameter

Type

Description

firstName

String

QR code Business Card First Name (Optional)

lastName

String

QR code Business Card Last Name (Optional)

jobTitle

String

QR code Business Card Title (Optional)

cellPhone

String

QR code Business Card Cell Phone Number (Optional)

phone

String

QR code Business Card Phone Number (Optional)

email

String

QR code Business Card Email Address (Optional)

organisation

String

QR code Business Card Organisation (Optional)

streetAddress

String

QR code Business Card Street Address (Optional)

city

String

QR code Business Card City (Optional)

adrState

String

QR code Business Card State (Optional)

country

String

QR code Business Card Country (Optional)

postalCode

String

QR code Business Card Postal Code (Optional)

website

String

QR code Business Card URL (Optional)

qrCodeSwatch

Swatch

String

Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)

withProperties

Array of String

Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)

undefined deleteAlternateLayout (name:String)

Deletes an alternate layout.

Parameter

Type

Description

name

String

The name of the alternate layout to delete.

undefined deleteUnusedTags ()

Deletes unused XML markup tags.

undefined distribute (alignDistributeItems:Array of PageItem, distributeOption:DistributeOptions, alignDistributeBounds:AlignDistributeBounds, useDistributeMeasurement:Boolean, absoluteDistributeMeasurement:Number String, reference:PageItem)

Distribute page items.

Parameter

Type

Description

alignDistributeItems

Array of PageItem

The page items to align or distribute

distributeOption

DistributeOptions

DistributeOptions.BOTTOM_EDGES

DistributeOptions.HORIZONTAL_CENTERS

DistributeOptions.HORIZONTAL_SPACE

DistributeOptions.LEFT_EDGES

DistributeOptions.RIGHT_EDGES

DistributeOptions.TOP_EDGES

DistributeOptions.VERTICAL_CENTERS

DistributeOptions.VERTICAL_SPACE

The type of distribution to apply.

alignDistributeBounds

AlignDistributeBounds

AlignDistributeBounds.ITEM_BOUNDS

AlignDistributeBounds.KEY_OBJECT

AlignDistributeBounds.MARGIN_BOUNDS

AlignDistributeBounds.PAGE_BOUNDS

AlignDistributeBounds.SPREAD_BOUNDS

The bounds within which to align or distribute the page items. (Optional)

useDistributeMeasurement

Boolean

If true, distribute space between page items. When this property is true, the bounds setting is ignored. (Optional)

absoluteDistributeMeasurement

Number

String

The distance to use when distributing page items. Required when 'align distribute bounds' specifies 'key object'. (Optional)

reference

PageItem

The reference or key object to align to distribute relative to. Required when 'align distribute bounds' specifies 'key object'. (Optional)

PreflightProfile embed (using:Varies String PreflightProfile)

Embed this profile to the document.

Parameter

Type

Description

using

String

PreflightProfile

The preflight profile to embed. Can accept: String or PreflightProfile.

undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

Exports the object(s) to a file.

Parameter

Type

Description

format

ExportFormat

ExportFormat.EPS_TYPE

ExportFormat.EPUB

ExportFormat.FIXED_LAYOUT_EPUB

ExportFormat.HTML

ExportFormat.HTMLFXL

ExportFormat.INCOPY_MARKUP

ExportFormat.INDESIGN_MARKUP

ExportFormat.INDESIGN_SNIPPET

ExportFormat.INTERACTIVE_PDF

ExportFormat.JPG

ExportFormat.PDF_TYPE

ExportFormat.PNG_FORMAT

ExportFormat.RTF

ExportFormat.TAGGED_TEXT

ExportFormat.TEXT_TYPE

ExportFormat.XML

String

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.

to

File

The path to the export file.

showingOptions

Boolean

If true, displays the export options dialog. (Optional)

(default: false)

using

PDFExportPreset

The export style. (Optional)

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

Boolean exportForCloudLibrary (jsondata:String)

Exports as assets required for cloud library.

Parameter

Type

Description

jsondata

String

JSON encoded information about the export.

undefined exportPageItemsSelectionToSnippet (to:File)

Exports selected page items to snippet on the destination file path.

Parameter

Type

Description

to

File

The path to the export file.

undefined exportPageItemsToSnippet (to:File, pageItemIds:Array of Number)

Exports input page item ids to snippet on the destination file path.

Parameter

Type

Description

to

File

The path to the export file.

pageItemIds

Array of Number

The array of the page item ids.

undefined exportStrokeStyles (to:File, strokeStyleList:Array of StrokeStyle, versionComments:String, [forceSave:Boolean=Boolean])

Exports stroke styles or presets.

Parameter

Type

Description

to

File

The file to save to

strokeStyleList

Array of StrokeStyle

The list of stroke styles to save

versionComments

String

The comment for this version (Optional)

forceSave

Boolean

Forcibly save a version (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Number findColor ()

Finds color that matches the find what value.

Text findGlyph (reverseOrder:Boolean)

Finds glyphs that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

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

Text findGrep (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

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

PageItem findObject (reverseOrder:Boolean)

Finds objects that match the find what value.

Parameter

Type

Description

reverseOrder

Boolean

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

Text findText (reverseOrder:Boolean)

Finds text that matches the find what value.

Parameter

Type

Description

reverseOrder

Boolean

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

Text findTransliterate (reverseOrder:Boolean)

Finds text that matches the find character type value.

Parameter

Type

Description

reverseOrder

Boolean

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

Varies getAlternateLayoutsForFolio (resolveMaster:Boolean)

This will return an array of structs containing information about the alternate layouts.

Parameter

Type

Description

resolveMaster

Boolean

Resolves layout policy if setting is "use master" - default is true. (Optional)

Document getElements ()

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

TextDirection getSelectedTextDirection ()

Selected text direction

Varies getStyleConflictResolutionStrategy (charOrParaStyle:StyleType)

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

Parameter

Type

Description

charOrParaStyle

StyleType

StyleType.CHARACTER_STYLE_TYPE

StyleType.PARAGRAPH_STYLE_TYPE

Style type to look at. (Optional)

Color importAdobeSwatchbookProcessColor (name:String)

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

Parameter

Type

Description

name

String

The process color to load.

Color importAdobeSwatchbookSpotColor (name:String)

Imports a spot color swatch from an Adobe color book.

Parameter

Type

Description

name

String

The spot color to load.

undefined importDtd (from:File)

Imports a DTD to use for validation.

Parameter

Type

Description

from

File

The path to the DTD file.

undefined importFormats (from:File)

Imports the cross reference formats from specified file.

Parameter

Type

Description

from

File

The file whose formats to import.

undefined importPdfComments (from:File, withProperties:Object)

Import Commemnts from PDF

Parameter

Type

Description

from

File

The PDF File from which you want to import comments.

withProperties

Object

Initial values for properties of the new Document (Optional)

undefined importStyles (format:ImportFormat, from:File, [globalStrategy:GlobalClashResolutionStrategy=GlobalClashResolutionStrategy])

Imports the specified styles.

Parameter

Type

Description

format

ImportFormat

ImportFormat.CELL_STYLES_FORMAT

ImportFormat.CHARACTER_STYLES_FORMAT

ImportFormat.OBJECT_STYLES_FORMAT

ImportFormat.PARAGRAPH_STYLES_FORMAT

ImportFormat.STROKE_STYLES_FORMAT

ImportFormat.TABLE_AND_CELL_STYLES_FORMAT

ImportFormat.TABLE_STYLES_FORMAT

ImportFormat.TEXT_STYLES_FORMAT

ImportFormat.TOC_STYLES_FORMAT

The types of styles to import.

from

File

The file containing the styles you want to import.

globalStrategy

GlobalClashResolutionStrategy

GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE

GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE

GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME

The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional)

(default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE)

undefined importXML (from:File)

Imports the specified XML file into an InDesign document.

Parameter

Type

Description

from

File

The XML file.

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

String internalMethod (internalParameter1:String, internalParameter2:String)

Internal use only: a black box method for use by InDesign Engineering team only.

Parameter

Type

Description

internalParameter1

String

The first internal parameter

internalParameter2

String

The second internal parameter

undefined loadConditions (from:File, loadConditionSets:Boolean)

Load conditions from the specified file.

Parameter

Type

Description

from

File

The path to the file that contains the conditions.

loadConditionSets

Boolean

If true, load the condition sets as well. (Optional)

undefined loadMasters (from:File, [globalStrategyForMasterPage:GlobalClashResolutionStrategyForMasterPage=GlobalClashResolutionStrategyForMasterPage])

Load masterpages from an InDesign file.

Parameter

Type

Description

from

File

The InDesign file to load the masters from.

globalStrategyForMasterPage

GlobalClashResolutionStrategyForMasterPage

GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE

GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_RENAME

the global clash resolution strategy for load master page (Optional)

(default: GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE)

undefined loadSwatches (from:File)

Load swatches from the specified file.

Parameter

Type

Description

from

File

The swatch file or InDesign document.

undefined loadXMLTags (from:File)

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

Parameter

Type

Description

from

File

The path to the file that contains the tags.

undefined mapStylesToXMLTags ()

Auto tag the document based on the style to tag mappings

undefined mapXMLTagsToStyles ()

Auto style the document based on the tag to style mappings

Boolean packageForPrint (to:File, copyingFonts:Boolean, copyingLinkedGraphics:Boolean, copyingProfiles:Boolean, updatingGraphics:Boolean, includingHiddenLayers:Boolean, ignorePreflightErrors:Boolean, creatingReport:Boolean, includeIdml:Boolean, includePdf:Boolean, pdfStyle:String, useDocumentHyphenationExceptionsOnly:Boolean, versionComments:String, [forceSave:Boolean=Boolean])

Packages the document.

Parameter

Type

Description

to

File

The folder, alias, or path in which to place the packaged files.

copyingFonts

Boolean

If true, copies fonts used in the document to the package folder.

copyingLinkedGraphics

Boolean

If true, copies linked graphics files to the package folder.

copyingProfiles

Boolean

If true, copies color profiles to the package folder.

updatingGraphics

Boolean

If true, updates graphics links to the package folder.

includingHiddenLayers

Boolean

If true, copies fonts and links from hidden layers to the package.

ignorePreflightErrors

Boolean

If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist.

creatingReport

Boolean

If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information.

includeIdml

Boolean

If true, generates and includes IDML in the package folder. (Optional)

includePdf

Boolean

If true, generates and includes PDF in the package folder. (Optional)

pdfStyle

String

If specified and PDF is to be included, use this style for PDF export if it is valid, otherwise use the last used PDF preset. (Optional)

useDocumentHyphenationExceptionsOnly

Boolean

If this option is selected, InDesign flags this document so that it does not reflow when someone else opens or edits it on a computer that has different hyphenation and dictionary settings. (Optional)

versionComments

String

The comments for the version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

undefined place (fileName:Array of Varies File Files., [showingOptions:Boolean=Boolean], withProperties:Object)

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.

Parameter

Type

Description

fileName

File

Array of Files.

One or more files to place. Can accept: File or Array of Files.

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

undefined placeAndLink (parentStory:Story, [showingOptions:Boolean=Boolean])

Deprecated: Use ContentPlacerObject load method. Original Description: Place following the behavior of the place and link story menu item. This will load the place gun.

Parameter

Type

Description

parentStory

Story

The story to place and link from.

showingOptions

Boolean

Whether to display the link options dialog (Optional)

(default: false)

undefined placeCloudAsset (jsondata:String)

place a cloud asset on the document

Parameter

Type

Description

jsondata

String

JSON data containing metadata about the cloud asset

undefined print (printDialog:Boolean, using:Varies PrinterPresetTypes PrinterPreset)

Prints the Document(s).

Parameter

Type

Description

printDialog

Boolean

Whether to invoke the print dialog (Optional)

using

PrinterPresetTypes

PrinterPresetTypes.CUSTOM

PrinterPresetTypes.DEFAULT_VALUE

PrinterPreset

Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

undefined printBooklet ([printBookletDialog:Boolean=Boolean], using:Varies PrinterPresetTypes PrinterPreset)

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

Parameter

Type

Description

printBookletDialog

Boolean

Whether to invoke the print booklet dialog (Optional)

(default: false)

using

PrinterPresetTypes

PrinterPresetTypes.CUSTOM

PrinterPresetTypes.DEFAULT_VALUE

PrinterPreset

Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

undefined recompose ()

Recomposes the text in the Document.

undefined redo ()

Redoes the last action.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined resetAllButtons ()

Resets all the buttons to their Normal state.

undefined resetAllMultiStateObjects ()

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

Boolean revert ()

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

undefined revertToProject ([forceRevert:Boolean=Boolean])

Reverts to the version of the document in Version Cue.

Parameter

Type

Description

forceRevert

Boolean

Forcibly reverts to the project version. (Optional)

(default: false)

Document save (to:File, [stationery:Boolean=Boolean], versionComments:String, [forceSave:Boolean=Boolean])

Save the document

Parameter

Type

Description

to

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)

stationery

Boolean

Whether to save the file as stationery (Optional)

(default: false)

versionComments

String

The comment for this version (Optional)

forceSave

Boolean

Forcibly save a version (Optional)

(default: false)

undefined saveACopy (to:File, [stationery:Boolean=Boolean])

Saves a copy of the document.

Parameter

Type

Description

to

File

The file path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)

stationery

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)

(default: false)

Document saveACopyCloud (cloudPath:String)

Save a copy as cloud document

Parameter

Type

Description

cloudPath

String

The cloud path in case of a cloud document

Document saveAsCloud (cloudPath:String)

Save as a cloud document

Parameter

Type

Description

cloudPath

String

The cloud path in case of a cloud document

undefined saveSwatches (to:File, swatchList:Array of Swatch, versionComments:String, [forceSave:Boolean=Boolean])

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

Parameter

Type

Description

to

File

The swatchbook file to save to.

swatchList

Array of Swatch

The swatch(es) to save.

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

undefined saveXMLTags (to:File, versionComments:String, [forceSave:Boolean=Boolean])

Saves a set of tags to an external file.

Parameter

Type

Description

to

File

The full path to the file in which to save the tags.

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

undefined select (selectableItems:Array of Varies Objects NothingEnum Object SelectAll, [existingSelection:SelectionOptions=SelectionOptions])

Selects the specified object(s).

Parameter

Type

Description

selectableItems

Array of Objects

NothingEnum.NOTHING

Object

SelectAll

SelectAll.ALL

The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

SelectionOptions.SET_KEY

The selection status of the Document in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

VersionCueSyncStatus synchronizeWithVersionCue ([syncConflictResolution:SyncConflictResolution=SyncConflictResolution], versionComments:String)

Synchronizes the file with the Version Cue project.

Parameter

Type

Description

syncConflictResolution

SyncConflictResolution

SyncConflictResolution.ASK_ABOUT_CONFLICTS

SyncConflictResolution.PREFER_LOCAL

SyncConflictResolution.PREFER_PROJECT

SyncConflictResolution.SKIP_CONFLICTS

The conflict resolution method to use during synchronization. (Optional)

(default: SyncConflictResolution.SKIP_CONFLICTS)

versionComments

String

The comments that describe the version. (Optional)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined undo ()

Undoes the last action.

undefined updateCrossReferences ()

Updates cross references' text source content in the document.

Object of

Book.styleSourceDocument

Application.activeDocument

AdjustLayoutPreference.parent

AnchoredObjectDefault.parent

AnchoredObjectSetting.parent

Article.parent

Assignment.parent

BaselineFrameGridOption.parent

Bookmark.parent

ButtonPreference.parent

CellStyle.parent

CellStyleGroup.parent

CellStyleMapping.parent

ChapterNumberPreference.parent

CharStyleMapping.parent

CharacterStyle.parent

CharacterStyleGroup.parent

CjkGridPreference.parent

Color.parent

ColorGroup.parent

CompositeFont.parent

Condition.parent

ConditionSet.parent

ConditionalTextPreference.parent

CrossReferenceFormat.parent

CrossReferenceSource.parent

DTD.parent

DashedStrokeStyle.parent

DataMerge.parent

DataMergeImagePlaceholder.parent

DataMergeOption.parent

DataMergeQrcodePlaceholder.parent

DataMergeTextPlaceholder.parent

DictionaryPreference.parent

DocumentEvent.parent

DocumentPreference.parent

DottedStrokeStyle.parent

EPubExportPreference.parent

EPubFixedLayoutExportPreference.parent

EndnoteOption.parent

Event.parent

EventListener.parent

ExportForWebPreference.parent

Font.parent

FootnoteOption.parent

FrameFittingOption.parent

GalleyPreference.parent

Gradient.parent

GridPreference.parent

GuidePreference.parent

HTMLExportPreference.parent

HTMLFXLExportPreference.parent

Hyperlink.parent

HyperlinkExternalPageDestination.parent

HyperlinkPageDestination.parent

HyperlinkPageItemSource.parent

HyperlinkTextDestination.parent

HyperlinkTextSource.parent

HyperlinkURLDestination.parent

HyphenationException.parent

ImportExportEvent.parent

Index.parent

IndexOptions.parent

IndexingSortOption.parent

Ink.parent

KinsokuTable.parent

Language.parent

Layer.parent

LayoutGridDataInformation.parent

LayoutWindow.parent

LinkedPageItemOption.parent

LinkedStoryOption.parent

MarginPreference.parent

MasterSpread.parent

MetadataPreference.parent

MixedInk.parent

MixedInkGroup.parent

MojikumiTable.parent

MojikumiUiPreference.parent

MotionPreset.parent

MutationEvent.parent

NamedGrid.parent

NumberingList.parent

ObjectStyle.parent

ObjectStyleGroup.parent

PDFComment.parent

PageItemDefault.parent

ParaStyleMapping.parent

ParagraphDestination.parent

ParagraphStyle.parent

ParagraphStyleGroup.parent

PasteboardPreference.parent

PlaceGun.parent

Preference.parent

PreflightOption.parent

PreflightProfile.parent

PrintBookletOption.parent

PrintBookletPrintPreference.parent

PrintEvent.parent

PrintPreference.parent

PublishExportPreference.parent

Section.parent

Spread.parent

Story.parent

StoryGridDataInformation.parent

StoryPreference.parent

StoryWindow.parent

StripedStrokeStyle.parent

StrokeStyle.parent

Swatch.parent

TOCStyle.parent

TableStyle.parent

TableStyleGroup.parent

TableStyleMapping.parent

TaggedPDFPreference.parent

TextDefault.parent

TextFramePreference.parent

TextPreference.parent

TextVariable.parent

TextWrapPreference.parent

Tint.parent

TransparencyPreference.parent

TrapPreset.parent

ValidationError.parent

ViewPreference.parent

WatermarkPreference.parent

Window.parent

XMLComment.parent

XMLElement.parent

XMLExportMap.parent

XMLExportPreference.parent

XMLImportMap.parent

XMLImportPreference.parent

XMLInstruction.parent

XMLItem.parent

XMLPreference.parent

XMLTag.parent

XMLViewPreference.parent

XmlStory.parent

PreflightProcess.targetObject

Return

Documents.add()

Application.openCloudDocument()

Document.getElements()

Documents.anyItem()

Documents.everyItem()

Documents.nextItem()

Documents.previousItem()

Documents.itemByID()

Documents.item()

Documents.[]()

Documents.itemByName()

Documents.itemByRange()

Documents.firstItem()

Documents.lastItem()

Documents.middleItem()

Document.saveACopyCloud()

Document.saveAsCloud()

Document.save()