BasicsDocument

A document.

Static Properties

Name Description
AFTER_ACTIVATE = "afterActivate" string Dispatched after the Document becomes active. This event bubbles. This event is not cancelable.
AFTER_EXPORT = "afterExport" string Dispatched after a Document is exported. This event bubbles. This event is not cancelable.
AFTER_IMPORT = "afterImport" string Dispatched after importing a file into a Document. This event bubbles. This event is not cancelable.
AFTER_LINKS_CHANGED = "afterLinksChanged" string 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 = "afterNew" string Dispatched after a Document is created. This event bubbles. This event is not cancelable.
AFTER_OPEN = "afterOpen" string Dispatched after a Document is opened. This event bubbles. This event is not cancelable.
AFTER_PRINT = "afterPrint" string Dispatched after a Document is printed. This event bubbles. This event is not cancelable.
AFTER_REVERT = "afterRevert" string Dispatched after a Document is reverted. This event bubbles. This event is not cancelable.
AFTER_SAVE = "afterSave" string Dispatched after a Document is saved. This event bubbles. This event is not cancelable.
AFTER_SAVE_AS = "afterSaveAs" string Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.
AFTER_SAVE_A_COPY = "afterSaveACopy" string Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.
BEFORE_CLOSE = "beforeClose" string Dispatched before a Document is closed. This event bubbles. This event is not cancelable.
BEFORE_DEACTIVATE = "beforeDeactivate" string Dispatched before the Document becomes inactive. This event bubbles. This event is not cancelable.
BEFORE_EXPORT = "beforeExport" string Dispatched before a Document is exported. This event bubbles. This event is cancelable.
BEFORE_IMPORT = "beforeImport" string Dispatched before importing a file into a Document. This event bubbles. This event is cancelable.
BEFORE_PRINT = "beforePrint" string Dispatched before a Document is printed. This event bubbles. This event is cancelable.
BEFORE_REVERT = "beforeRevert" string Dispatched before a Document is reverted. This event bubbles. This event is cancelable.
BEFORE_SAVE = "beforeSave" string Dispatched before a Document is saved. This event bubbles. This event is cancelable.
BEFORE_SAVE_AS = "beforeSaveAs" string Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.
BEFORE_SAVE_A_COPY = "beforeSaveACopy" string Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.
FAILED_EXPORT = "failedExport" string Dispatched after a Document export is canceled or fails. This event bubbles. This event is not cancelable.

Instance Properties

Name Description Access
accurateLABSpots bool If true, uses LAB alternates for spot colors when available. read-write
activeLayer Layer The active layer. Can also accept: String. read-write
activeProcess PreflightProcess The active preflight process for this document. read-only
afterBlendingIntent RenderingIntent The rendering intent for colors that result from transparency interactions on the page after blending. read-write
allCellStyles CellStyle All Cell styles read-only
allCharacterStyles CharacterStyle Lists all character styles (regardless of their group). read-only
allGraphics Graphic Lists all graphics contained by the Document. read-only
allObjectStyles ObjectStyle All object styles contained by the Document. read-only
allPageItems PageItem Lists all page items contained by the Document. read-only
allParagraphStyles ParagraphStyle Lists all paragraph styles (regardless of their group). read-only
allTableStyles TableStyle All Table styles read-only
anchoredObjectDefaults AnchoredObjectDefault Anchored object default settings. read-only
anchoredObjectSettings AnchoredObjectSetting Anchored object settings. read-only
articles Articles A collection of articles. read-only
assignments Assignments A collection of assignments. read-only
associatedXMLElement XMLItem The XML element associated with the Document. read-only
baselineFrameGridOptions BaselineFrameGridOption Baseline frame grid option settings. read-only
bookmarks Bookmarks A collection of bookmarks. read-only
buttonPreferences ButtonPreference Button preference settings. read-only
buttons Buttons A collection of buttons. read-only
cellStyleGroups CellStyleGroups A collection of cell style groups. read-only
cellStyleMappings CellStyleMappings A collection of cell style mappings. read-only
cellStyles CellStyles A collection of cell styles. read-only
chapterNumberPreferences ChapterNumberPreference Chapter numbering preferences. read-only
charStyleMappings CharStyleMappings A collection of char style mappings. read-only
characterStyleGroups CharacterStyleGroups A collection of character style groups. read-only
characterStyles CharacterStyles A collection of character styles. read-only
checkBoxes CheckBoxes A collection of checkboxes. read-only
cjkGridPreferences CjkGridPreference CJK grid preference settings. read-only
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. read-write
cmykProfile string The current CMYK profile. read-write
cmykProfileList string A list of valid CMYK profiles. read-only
colorGroups ColorGroups A collection of color groups. read-only
colors Colors A collection of colors. read-only
comboBoxes ComboBoxes A collection of comboboxes. read-only
compositeFonts CompositeFonts A collection of composite fonts. read-only
conditionSets ConditionSets A collection of condition sets for conditional text. read-only
conditionalTextPreferences ConditionalTextPreference Conditional text preferences. read-only
conditions Conditions A collection of conditions for conditional text. read-only
converted bool If true, the Document was converted. read-only
crossReferenceFormats CrossReferenceFormats A collection of cross reference formats. read-only
crossReferenceSources CrossReferenceSources A collection of cross reference text sources. read-only
dashedStrokeStyles DashedStrokeStyles A collection of dashed stroke styles. read-only
dataMergeImagePlaceholders DataMergeImagePlaceholders A collection of data merge image placeholders. read-only
dataMergeOptions DataMergeOption The data merge option properties that define the data merge. read-only
dataMergeProperties DataMerge Data merge properties that define data merge fields and preferences. read-only
dataMergeQrcodePlaceholders DataMergeQrcodePlaceholders A collection of data merge QR code placeholders. read-only
dataMergeTextPlaceholders DataMergeTextPlaceholders A collection of data merge text placeholders. read-only
defaultImageIntent RenderingIntent The rendering intent for bitmap images. read-write
dictionaryPreferences DictionaryPreference User dictionary preference settings. read-only
documentPreferences DocumentPreference Document preference settings. read-only
dottedStrokeStyles DottedStrokeStyles A collection of dotted stroke styles. read-only
dtds DTDs A collection of DTDs. read-only
editingState EditingState The Version Cue editing state of the file. read-only
endnoteOptions EndnoteOption Endnote option settings. read-only
endnoteTextFrames EndnoteTextFrames A collection of endnote text frames. read-only
epstexts EPSTexts EPSTexts read-only
epubExportPreferences EPubExportPreference EPub export preference settings. read-only
epubFixedLayoutExportPreferences EPubFixedLayoutExportPreference EPub fixed layout export preference settings. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
exportForWebPreferences ExportForWebPreference The default export for web preferences. read-only
filePath File The full path to the file. read-only
fonts Fonts A collection of fonts. read-only
footnoteOptions FootnoteOption Footnote option settings. read-only
formFields FormFields A collection of form fields. read-only
frameFittingOptions FrameFittingOption 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. read-only
fullName File The full path to the Document, including the name of the Document. read-only
galleyPreferences GalleyPreference Galley preference settings. read-only
gradients Gradients A collection of gradients. read-only
graphicLines GraphicLines A collection of graphic lines. read-only
gridPreferences GridPreference Grid preference settings. read-only
groups Groups A collection of groups. read-only
guidePreferences GuidePreference Guide preference settings. read-only
guides Guides A collection of guides. read-only
htmlExportPreferences HTMLExportPreference HTML export preference settings. read-only
htmlFXLExportPreferences HTMLFXLExportPreference HTML FXL export preference settings. read-only
hyperlinkExternalPageDestinations HyperlinkExternalPageDestinations A collection of hyperlink external page destinations. read-only
hyperlinkPageDestinations HyperlinkPageDestinations A collection of hyperlink page destinations. read-only
hyperlinkPageItemSources HyperlinkPageItemSources A collection of hyperlink page item sources. read-only
hyperlinkTextDestinations HyperlinkTextDestinations A collection of hyperlink text destinations. read-only
hyperlinkTextSources HyperlinkTextSources A collection of hyperlink text sources. read-only
hyperlinkURLDestinations HyperlinkURLDestinations A collection of hyperlink URL destinations. read-only
hyperlinks Hyperlinks A collection of hyperlinks. read-only
hyphenationExceptions HyphenationExceptions A collection of hyphenation exceptions lists. read-only
id number The unique ID of the Document. read-only
index number The index of the Document within its containing object. read-only
indexGenerationOptions IndexOptions The index options properties that define how an index is formatted. read-only
indexes Indexes A collection of indexes. read-only
indexingSortOptions IndexingSortOptions A collection of indexing sort options. read-only
inks Inks A collection of inks. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4Articles K4Articles K4 Articles read-only
k4DesignName string K4 Design Name read-only
k4FileVersionIndex number K4 File Version Index read-only
k4Id string K4 Server ID read-only
k4Name string K4 Name read-only
k4ObjectLabel string K4 Object Label read-only
k4ObjectState K4ObjectState K4 Object State read-only
k4ObjectType K4ObjectType K4 Object Type read-only
k4OutputChannelName string K4 Output Channel Name read-only
k4PublicationId string K4 Publication ID read-only
k4VariantId string K4 Variant ID read-only
k4WfChannelId string K4 Workflow Channel ID read-only
k4WfDefinitionId string K4 Workflow Definition ID read-only
k4WfName string K4 Workflow Name read-only
k4WfObjectType K4WfObjectType K4 Workflow Object Type read-only
k4WfObjectVariantId string K4 Workflow Object Variant ID read-only
kinsokuTables KinsokuTables A collection of kinsoku tables. read-only
label string A property that can be set to any string. read-write
languages Languages A collection of languages. read-only
layers Layers A collection of layers. read-only
layoutAdjustmentPreferences LayoutAdjustmentPreference Layout sdjustment preference settings. read-only
layoutGridData LayoutGridDataInformation Default properties specific to layout grids. read-only
layoutWindows LayoutWindows A collection of layout windows. read-only
linkedPageItemOptions LinkedPageItemOption Linked Page Item options read-only
linkedStoryOptions LinkedStoryOption Linked story options read-only
links Links A collection of links. read-only
listBoxes ListBoxes A collection of listboxes. read-only
marginPreferences MarginPreference Margin preference settings. read-only
masterSpreads MasterSpreads A collection of master spreads. read-only
metadataPreferences MetadataPreference Metadata preference settings. read-only
mixedInkGroups MixedInkGroups A collection of mixed ink groups. read-only
mixedInks MixedInks A collection of mixed inks. read-only
modified bool If true, the Document has been modified since it was last saved. read-only
mojikumiTables MojikumiTables A collection of mojikumi tables. read-only
mojikumiUIPreferences MojikumiUiPreference Mojikumi user interface preference settings. read-only
motionPresets MotionPresets A collection of Motion presets. read-only
multiStateObjects MultiStateObjects A collection of multi-state objects. read-only
name string The name of the Document. read-write
namedGrids NamedGrids A collection of named grids. read-only
numberingLists NumberingLists A collection of numbered lists. read-only
objectStyleGroups ObjectStyleGroups A collection of object style groups. read-only
objectStyles ObjectStyles A collection of object styles. read-only
ovals Ovals A collection of ellipses. read-only
pageItemDefaults PageItemDefault The default page item formatting for the Document. read-only
pageItems PageItems 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. read-only
pages Pages A collection of pages. read-only
paraStyleMappings ParaStyleMappings A collection of para style mappings. read-only
paragraphDestinations ParagraphDestinations A collection of paragraph destinations. read-only
paragraphStyleGroups ParagraphStyleGroups A collection of paragraph style groups. read-only
paragraphStyles ParagraphStyles A collection of paragraph styles. read-only
parent Application The parent of the Document (a Application). read-only
pasteboardPreferences PasteboardPreference Pasteboard preference settings. read-only
placeGuns PlaceGun The place gun. read-only
polygons Polygons A collection of polygons. read-only
preferences Preferences A collection of preferences objects. read-only
preflightOptions PreflightOption Preflight option settings. read-only
preflightProfiles PreflightProfiles A collection of preflight profiles. read-only
printBookletOptions PrintBookletOption Booklet printing options. read-only
printBookletPrintPreferences PrintBookletPrintPreference Print booklet preferences. read-only
printPreferences PrintPreference Print preference settings. read-only
properties Object A property that allows setting of several properties at the same time. read-write
publishExportPreferences PublishExportPreference Publish export preference settings. read-only
radioButtons RadioButtons A collection of radio buttons. read-only
readOnly bool If true, the Document is read-only. read-only
recovered bool If true, the Document was recovered. read-only
rectangles Rectangles A collection of rectangles. read-only
redoHistory string The names of the items in the redo stack. read-only
redoName string The name of the action on the top of the redo stack. read-only
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. read-write
rgbProfile string The current RGB profile. read-write
rgbProfileList string A list of valid RGB profiles. read-only
saved bool If true, the Document has been saved since it was created. read-only
sections Sections A collection of sections. read-only
selectedPageItems Object The selected page item(s). Can also accept: Object or NothingEnum enumerator. read-only
selection Object The selected object(s). Can also accept: Object or NothingEnum enumerator. read-write
selectionKeyObject PageItem The key object of the selection. Can also accept: NothingEnum enumerator. read-write
signatureFields SignatureFields A collection of signature fields. read-only
solidColorIntent RenderingIntent The rendering intent for all vector art (areas of solid color) in native objects. read-write
splineItems SplineItems The spline items collection. read-only
spreads Spreads A collection of spreads. read-only
stories Stories A collection of stories. read-only
storyGridData StoryGridDataInformation Default properties specific to frame grids. read-only
storyPreferences StoryPreference Story preference settings. read-only
storyWindows StoryWindows A collection of story windows. read-only
stripedStrokeStyles StripedStrokeStyles A collection of striped stroke styles. read-only
strokeStyles StrokeStyles A collection of stroke styles. read-only
swatches Swatches A collection of swatches. read-only
tableStyleGroups TableStyleGroups A collection of table style groups. read-only
tableStyleMappings TableStyleMappings A collection of table style mappings. read-only
tableStyles TableStyles A collection of table styles. read-only
taggedPDFPreferences TaggedPDFPreference Tagged PDF preferences. read-only
textBoxes TextBoxes A collection of text boxes. read-only
textDefaults TextDefault Text default settings. read-only
textFrameFootnoteOptions TextFrameFootnoteOptionsObject Text frame footnote options settings. read-only
textFramePreferences TextFramePreference Text frame preference settings. read-only
textFrames TextFrames A collection of text frames. read-only
textPreferences TextPreference Text preference settings. read-only
textVariables TextVariables A collection of text variables. read-only
textWrapPreferences TextWrapPreference The text wrap preference properties that define the default formatting for wrapping text around objects. read-only
tints Tints A collection of tints. read-only
tocStyles TOCStyles A collection of TOC styles. read-only
transparencyPreferences TransparencyPreference Transparency preference settings. read-only
trapPresets TrapPresets A collection of trap presets. read-only
undoHistory string The names of the items in the undo stack. read-only
undoName string The name of the action on the top of the undo stack. read-only
unusedSwatches Swatch The swatches that are not being used. read-only
validationErrors ValidationErrors A collection of XML validation errors. read-only
versionState VersionState The Version Cue version state of the file. read-only
viewPreferences ViewPreference View preference settings. read-only
visible bool If true, the Document is visible. read-only
watermarkPreferences WatermarkPreference Watermark preferences read-only
windows Windows A collection of windows. read-only
xmlComments XMLComments A collection of XML comments. read-only
xmlElements XMLElements A collection of XML elements. read-only
xmlExportMaps XMLExportMaps A collection of XML export maps. read-only
xmlExportPreferences XMLExportPreference XML export preference settings. read-only
xmlImportMaps XMLImportMaps A collection of XML import maps. read-only
xmlImportPreferences XMLImportPreference XML import preference settings. read-only
xmlInstructions XMLInstructions A collection of XML instructions. read-only
xmlItems XMLItems A collection of XML items. read-only
xmlPreferences XMLPreference The XML preference settings. read-only
xmlStories XmlStories A collection of xml stories. read-only
xmlTags XMLTags A collection of XML tags. read-only
xmlViewPreferences XMLViewPreference XML view preference settings. read-only
zeroPoint Measurement Unit (Number or String)=any The ruler origin, specified as page coordinates in the format [x, y]. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
 → EventListener
align(
alignDistributeItems, alignOption ​[, alignDistributeBounds] ​[, reference])
asynchronousExportFile(
format, to ​[, showingOptions] ​[, using] ​[, versionComments] ​[, forceSave])
 → BackgroundTask
changeGlyph(
[reverseOrder])
 → Text
changeGrep(
[reverseOrder])
 → Text
changeObject(
[reverseOrder])
 → PageItem
changeText(
[reverseOrder])
 → Text
changeTransliterate(
[reverseOrder])
 → Text
checkIn(
[versionComments] ​[, forceSave])
close(
[saving] ​[, savingIn] ​[, versionComments] ​[, forceSave])
colorTransform(
colorValue, sourceColorSpace, destinationColorSpace)
 → number
createAlternateLayout(
spreadItems, name, width, height, createTextStyles, linkTextStories, layoutRule)
createEmailQRCode(
[emailAddress] ​[, subject] ​[, body], qrCodeSwatch ​[, withProperties])
createHyperlinkQRCode(
[urlLink], qrCodeSwatch ​[, withProperties])
createMissingFontObject(
fontFamily, fontStyleName, postscriptName)
 → Font
createPlainTextQRCode(
[plainText], qrCodeSwatch ​[, withProperties])
createTOC(
using ​[, replacing] ​[, fromBook] ​[, placePoint] ​[, includeOverset] ​[, destinationLayer])
 → Story
createTextMsgQRCode(
[cellNumber] ​[, textMessage], qrCodeSwatch ​[, withProperties])
createVCardQRCode(
[firstName] ​[, lastName] ​[, jobTitle] ​[, cellPhone] ​[, phone] ​[, email] ​[, organisation] ​[, streetAddress] ​[, city] ​[, adrState] ​[, country] ​[, postalCode] ​[, website], qrCodeSwatch ​[, withProperties])
distribute(
alignDistributeItems, distributeOption ​[, alignDistributeBounds] ​[, useDistributeMeasurement] ​[, absoluteDistributeMeasurement] ​[, reference])
embed(
using)
 → PreflightProfile
exportFile(
format, to ​[, showingOptions] ​[, using] ​[, versionComments] ​[, forceSave])
exportForCloudLibrary(
jsondata)
 → bool
exportPageItemsToSnippet(
to, pageItemIds)
exportStrokeStyles(
to, strokeStyleList ​[, versionComments] ​[, forceSave])
extractLabel(
key)
 → string
findGlyph(
[reverseOrder])
 → Text
findGrep(
[reverseOrder])
 → Text
findObject(
[reverseOrder])
 → PageItem
findText(
[reverseOrder])
 → Text
findTransliterate(
[reverseOrder])
 → Text
getAlternateLayoutsForFolio(
[resolveMaster])
importDtd(
from)
importFormats(
from)
importStyles(
format, from ​[, globalStrategy])
importXML(
from)
insertLabel(
key, value)
k4GetObjectById(
k4Id)
 → Object
k4GetObjectByName(
k4Name)
 → Object
k4GetObjects(
)
 → Object
k4GetShowFrameIconsState(
)
 → bool
k4SaveAsRevoked(
k4FilePath)
loadConditions(
from ​[, loadConditionSets])
loadMasters(
from ​[, globalStrategyForMasterPage])
loadSwatches(
from)
loadXMLTags(
from)
packageForPrint(
to, copyingFonts, copyingLinkedGraphics, copyingProfiles, updatingGraphics, includingHiddenLayers, ignorePreflightErrors, creatingReport ​[, includeIdml] ​[, includePdf] ​[, pdfStyle] ​[, useDocumentHyphenationExceptionsOnly] ​[, versionComments] ​[, forceSave])
 → bool
place(
fileName ​[, showingOptions] ​[, withProperties])
placeAndLink(
parentStory ​[, showingOptions])
placeCloudAsset(
jsondata)
print(
[printDialog], using)
printBooklet(
[printBookletDialog], using)
redo(
)
removeEventListener(
eventType, handler ​[, captures])
 → bool
revert(
)
 → bool
revertToProject(
[forceRevert])
save(
[to] ​[, stationery] ​[, versionComments] ​[, forceSave])
 → Document
saveACopy(
[to] ​[, stationery])
saveSwatches(
to, swatchList ​[, versionComments] ​[, forceSave])
saveXMLTags(
to ​[, versionComments] ​[, forceSave])
select(
selectableItems ​[, existingSelection])
synchronizeWithVersionCue(
[syncConflictResolution] ​[, versionComments])
 → VersionCueSyncStatus
toSource(
)
 → string
toSpecifier(
)
 → string
undo(
)
addEventListener(
eventType, handler ​[, captures=false])
 → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
align(
alignDistributeItems, alignOption ​[, alignDistributeBounds] ​[, reference])
Align page items.
alignDistributeItems Array<PageItem> The page items to align or distribute.
alignOption AlignOptions The type of alignment to apply.
alignDistributeBounds AlignDistributeBounds 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)
asynchronousExportFile(
format, to ​[, showingOptions=false] ​[, using] ​[, versionComments] ​[, forceSave=false])
 → BackgroundTask
asynchronously exports the object(s) to a file.
format 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 bool If true, displays the export options dialog. (Optional)
using PDFExportPreset The export style. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
changeComposer(
)
Change comoser to optyca
changeGlyph(
[reverseOrder])
 → Text
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeGrep(
[reverseOrder])
 → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeObject(
[reverseOrder])
 → PageItem
Finds objects that match the find what value and replace the objects with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeText(
[reverseOrder])
 → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeTransliterate(
[reverseOrder])
 → Text
Finds text that matches the find character type value and replaces the text with the change character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
checkIn(
[versionComments] ​[, forceSave=false])
Check in to Version Cue.
versionComments string The comment for this version (Optional)
forceSave bool Forcibly save a version (Optional)
clearFrameFittingOptions(
)
Removes the frame fittings options and resets it to the initial state.
close(
[saving=SaveOptions.ASK] ​[, savingIn] ​[, versionComments] ​[, forceSave=false])
Close the Document
saving SaveOptions Whether to save changes before closing the Document (Optional)
savingIn File The file in which to save the Document (Optional)
versionComments string The comment for this version (Optional)
forceSave bool Forcibly save a version (Optional)
colorTransform(
colorValue, sourceColorSpace, destinationColorSpace)
 → number
Transforms color values
colorValue Array<number> source color value
sourceColorSpace ColorSpace source color space
destinationColorSpace ColorSpace destination color space
createAlternateLayout(
spreadItems, name, width, height, createTextStyles, linkTextStories, layoutRule)
Creates an alternate layout for a given list of spreads.
spreadItems Array<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 Measurement Unit (Number or String)=any The width of the pages created.
height Measurement Unit (Number or String)=any The height of the pages created.
createTextStyles bool Whether to create new text styles.
linkTextStories bool Whether to create linked text for duplicated text stories.
layoutRule LayoutRuleOptions What layout rule to set on the pages.
createEmailQRCode(
[emailAddress] ​[, subject] ​[, body], qrCodeSwatch ​[, withProperties])
Create Email QR Code on the page item or document
emailAddress string QR code Email Address (Optional)
subject string QR code Email Subject (Optional)
body string QR code Email Body Message (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)
createHyperlinkQRCode(
[urlLink], qrCodeSwatch ​[, withProperties])
Create Hyperlink QR Code on the page item or document
urlLink string QR code Hyperlink URL (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)
createMissingFontObject(
fontFamily, fontStyleName, postscriptName)
 → Font
Create a missing font object.
fontFamily string The name of the font family
fontStyleName string The name of the font style.
postscriptName string The PostScript name of the font.
createPlainTextQRCode(
[plainText], qrCodeSwatch ​[, withProperties])
Create Plain Text QR Code on the page item
plainText string QR code Plain Text (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)
createTOC(
using ​[, replacing=false] ​[, fromBook] ​[, placePoint] ​[, includeOverset=false] ​[, destinationLayer])
 → Story
Creates a table of contents.
using TOCStyle The TOC style to use to define the content, title, and format of the table of contents.
replacing bool If true, replaces the existing TOC. (Optional)
fromBook Book The book whose documents to include in the TOC. (Optional)
placePoint Array<Measurement Unit (Number or String)=any> The point at which to place the TOC story, specified as page coordinates in the format [x, y]. (Optional)
includeOverset bool If true, includes overset text TOC entries in the TOC. (Optional)
destinationLayer Layer The layer on which to place the TOC. (Optional)
createTextMsgQRCode(
[cellNumber] ​[, textMessage], qrCodeSwatch ​[, withProperties])
Create Text Msg QR Code on the page item or document
cellNumber string QR code Text Phone Number (Optional)
textMessage string QR code Text Message (Optional)
qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)
createVCardQRCode(
[firstName] ​[, lastName] ​[, jobTitle] ​[, cellPhone] ​[, phone] ​[, email] ​[, organisation] ​[, streetAddress] ​[, city] ​[, adrState] ​[, country] ​[, postalCode] ​[, website], qrCodeSwatch ​[, withProperties])
Create Business Card QR Code on the page item or load on document's placegun
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 to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional)
withProperties Array<string> Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional)
deleteAlternateLayout(
name)
Deletes an alternate layout.
name string The name of the alternate layout to delete.
deleteUnusedTags(
)
Deletes unused XML markup tags.
distribute(
alignDistributeItems, distributeOption ​[, alignDistributeBounds] ​[, useDistributeMeasurement] ​[, absoluteDistributeMeasurement] ​[, reference])
Distribute page items.
alignDistributeItems Array<PageItem> The page items to align or distribute
distributeOption DistributeOptions The type of distribution to apply.
alignDistributeBounds AlignDistributeBounds The bounds within which to align or distribute the page items. (Optional)
useDistributeMeasurement bool If true, distribute space between page items. When this property is true, the bounds setting is ignored. (Optional)
absoluteDistributeMeasurement Measurement Unit (Number or String)=any 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)
embed(
using)
 → PreflightProfile
Embed this profile to the document.
using The preflight profile to embed. Can accept: String or PreflightProfile.
exportFile(
format, to ​[, showingOptions=false] ​[, using] ​[, versionComments] ​[, forceSave=false])
Exports the object(s) to a file.
format 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 bool If true, displays the export options dialog. (Optional)
using PDFExportPreset The export style. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
exportForCloudLibrary(
jsondata)
 → bool
Exports as assets required for cloud library.
jsondata string JSON encoded information about the export.
exportPageItemsSelectionToSnippet(
to)
Exports selected page items to snippet on the destination file path.
to File The path to the export file.
exportPageItemsToSnippet(
to, pageItemIds)
Exports input page item ids to snippet on the destination file path.
to File The path to the export file.
pageItemIds Array<number> The array of the page item ids.
exportStrokeStyles(
to, strokeStyleList ​[, versionComments] ​[, forceSave=false])
Exports stroke styles or presets.
to File The file to save to
strokeStyleList Array<StrokeStyle> The list of stroke styles to save
versionComments string The comment for this version (Optional)
forceSave bool Forcibly save a version (Optional)
extractLabel(
key)
 → string
Gets the label value associated with the specified key.
key string The key.
findGlyph(
[reverseOrder])
 → Text
Finds glyphs that match the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findGrep(
[reverseOrder])
 → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findObject(
[reverseOrder])
 → PageItem
Finds objects that match the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findText(
[reverseOrder])
 → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findTransliterate(
[reverseOrder])
 → Text
Finds text that matches the find character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
getAlternateLayoutsForFolio(
[resolveMaster])
This will return an array of structs containing information about the alternate layouts.
resolveMaster bool Resolves layout policy if setting is "use master" - default is true. (Optional)
getElements(
)
 → Document
Resolves the object specifier, creating an array of object references.
getSelectedTextDirection(
)
 → TextDirection
Selected text direction
getStyleConflictResolutionStrategy(
[charOrParaStyle])
Get the resolution strategy for style conflict, false if the user cancels
charOrParaStyle StyleType Style type to look at. (Optional)
importAdobeSwatchbookProcessColor(
name)
 → Color
Imports a process color swatch from a preloaded Adobe color book.
name string The process color to load.
importAdobeSwatchbookSpotColor(
name)
 → Color
Imports a spot color swatch from an Adobe color book.
name string The spot color to load.
importDtd(
from)
Imports a DTD to use for validation.
from File The path to the DTD file.
importFormats(
from)
Imports the cross reference formats from specified file.
from File The file whose formats to import.
importStyles(
format, from ​[, globalStrategy=GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE])
Imports the specified styles.
format ImportFormat The types of styles to import.
from File The file containing the styles you want to import.
globalStrategy GlobalClashResolutionStrategy The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional)
importXML(
from)
Imports the specified XML file into an InDesign document.
from File The XML file.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
k4DetachFromDocument(
objectId)
K4 Detach Object from Layout
objectId number Object, must be a K4 object
k4GetObjectById(
k4Id)
 → Object
K4 Get Object By ID
k4Id string K4 ID
k4GetObjectByName(
k4Name)
 → Object
K4 Get Object By Name
k4Name string K4 Name
k4GetObjects(
)
 → Object
K4 Get Objects
k4GetServerData(
)
 → K4ServerData
K4 Get Server Data
k4GetShowArticleColorsState(
)
 → bool
K4 Get Show Article Colors State
k4GetShowFrameIconsState(
)
 → bool
K4 Get Show Frame Icons State
k4GetShowFrameToolTipsState(
)
 → bool
K4 Get Show Frame Tools Tips State
k4Revoke(
)
K4 Revoke
k4SaveAsRevoked(
k4FilePath)
K4 Save As Revoked
k4FilePath string K4 File Path
k4SetArticleColorsState(
show)
K4 Set Article Colors State
show bool Show
k4SetFrameIconsState(
show)
K4 Set Frame Icons State
show bool Show
k4SetFrameToolTipsState(
show)
K4 Set Frame Tool Tips State
show bool Show
k4SwitchVariants(
k4Id)
K4 Switch Variants
k4Id string K4 ID
loadConditions(
from ​[, loadConditionSets])
Load conditions from the specified file.
from File The path to the file that contains the conditions.
loadConditionSets bool If true, load the condition sets as well. (Optional)
loadMasters(
from ​[, globalStrategyForMasterPage=GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE])
Load masterpages from an InDesign file.
from File The InDesign file to load the masters from.
globalStrategyForMasterPage GlobalClashResolutionStrategyForMasterPage the global clash resolution strategy for load master page (Optional)
loadSwatches(
from)
Load swatches from the specified file.
from File The swatch file or InDesign document.
loadXMLTags(
from)
Loads a set of XML markup tags from the specified file.
from File The path to the file that contains the tags.
mapStylesToXMLTags(
)
Auto tag the document based on the style to tag mappings
mapXMLTagsToStyles(
)
Auto style the document based on the tag to style mappings
packageForPrint(
to, copyingFonts, copyingLinkedGraphics, copyingProfiles, updatingGraphics, includingHiddenLayers, ignorePreflightErrors, creatingReport ​[, includeIdml] ​[, includePdf] ​[, pdfStyle] ​[, useDocumentHyphenationExceptionsOnly] ​[, versionComments] ​[, forceSave=false])
 → bool
Packages the document.
to File The folder, alias, or path in which to place the packaged files.
copyingFonts bool If true, copies fonts used in the document to the package folder.
copyingLinkedGraphics bool If true, copies linked graphics files to the package folder.
copyingProfiles bool If true, copies color profiles to the package folder.
updatingGraphics bool If true, updates graphics links to the package folder.
includingHiddenLayers bool If true, copies fonts and links from hidden layers to the package.
ignorePreflightErrors bool If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist.
creatingReport bool If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information.
includeIdml bool If true, generates and includes IDML in the package folder. (Optional)
includePdf bool 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 bool 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 bool If true, forcibly saves a version. (Optional)
place(
fileName ​[, showingOptions=false] ​[, withProperties])
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.
fileName One or more files to place. Can accept: File or Array of Files.
showingOptions bool Whether to display the import options dialog (Optional)
withProperties Object Initial values for properties of the placed object(s) (Optional)
placeAndLink(
parentStory ​[, showingOptions=false])
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.
parentStory Story The story to place and link from.
showingOptions bool Whether to display the link options dialog (Optional)
placeCloudAsset(
jsondata)
place a cloud asset on the document
jsondata string JSON data containing metadata about the cloud asset
print(
[printDialog], using)
Prints the Document(s).
printDialog bool Whether to invoke the print dialog (Optional)
using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)
printBooklet(
[printBookletDialog=false], using)
Print the Booklet using current document and Booklet and Print settings in the document
printBookletDialog bool Whether to invoke the print booklet dialog (Optional)
using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)
recompose(
)
Recomposes the text in the Document.
redo(
)
Redoes the last action.
removeEventListener(
eventType, handler ​[, captures=false])
 → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
resetAllButtons(
)
Resets all the buttons to their Normal state.
resetAllMultiStateObjects(
)
Resets all the multi-state objects to their first state.
revert(
)
 → bool
Reverts the document to its state at the last save operation.
revertToProject(
[forceRevert=false])
Reverts to the version of the document in Version Cue.
forceRevert bool Forcibly reverts to the project version. (Optional)
save(
[to] ​[, stationery=false] ​[, versionComments] ​[, forceSave=false])
 → Document
Save the document
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 bool Whether to save the file as stationery (Optional)
versionComments string The comment for this version (Optional)
forceSave bool Forcibly save a version (Optional)
saveACopy(
[to] ​[, stationery=false])
Saves a copy of the document.
to File The file path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)
stationery bool 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(
to, swatchList ​[, versionComments] ​[, forceSave=false])
Saves the specified swatch(es) to a swatchbook file.
to File The swatchbook file to save to.
swatchList Array<Swatch> The swatch(es) to save.
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
saveXMLTags(
to ​[, versionComments] ​[, forceSave=false])
Saves a set of tags to an external file.
to File The full path to the file in which to save the tags.
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
select(
selectableItems ​[, existingSelection=SelectionOptions.REPLACE_WITH])
Selects the specified object(s).
selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator.
existingSelection SelectionOptions The selection status of the Document in relation to previously selected objects. (Optional)
synchronizeWithVersionCue(
[syncConflictResolution=SyncConflictResolution.SKIP_CONFLICTS] ​[, versionComments])
 → VersionCueSyncStatus
Synchronizes the file with the Version Cue project.
syncConflictResolution SyncConflictResolution The conflict resolution method to use during synchronization. (Optional)
versionComments string The comments that describe the version. (Optional)
toSource(
)
 → string
Generates a string which, if executed, will return the Document.
toSpecifier(
)
 → string
Retrieves the object specifier.
undo(
)
Undoes the last action.
updateCrossReferences(
)
Updates cross references' text source content in the document.