BasicsDocument

Static Properties

Instance Properties

Methods

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.