Document

The event type.

handler

JavaScriptFunction

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

captures

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)

Parameter

Type

Description

versionComments

The comment for this version (Optional)

forceSave

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

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)

SVG createFromMathML (mathmlDescription:String, destinationPage:Page, destinationLayer:Layer, placePoint:Array of Number String)

Creates a new object from MathML description.

Parameter	Type	Description
mathmlDescription	String	The MathML description to create the SVG from.
destinationPage	Page	The page on which to create the object.
destinationLayer	Layer	The layer on which to create the Object.
placePoint	Array of Number Array of String	The point where to place the object (only applicable if you are telling a page or spread to place)

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)

Parameter

Type

Description

urlLink

QR code Hyperlink URL (Optional)

qrCodeSwatch

Swatch

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)

Parameter

Type

Description

plainText

QR code Plain Text (Optional)

qrCodeSwatch

Swatch

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.

Parameter

Type

Description

using

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)

Parameter

Type

Description

charOrParaStyle

StyleType

StyleType.CHARACTER_STYLE_TYPE

StyleType.PARAGRAPH_STYLE_TYPE

Style type to look at. (Optional)

undefined handleMathMLMessage (resyncData:String)

Internal Use Only

Parameter	Type	Description
resyncData	String	Internal Use Only

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)

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

GlobalClashResolutionStrategy

The file containing the styles you want to import.

globalStrategy

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

GlobalClashResolutionStrategyForMasterPage

The InDesign file to load the masters from.

globalStrategyForMasterPage

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

Array of Files.

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

showingOptions

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

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

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

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

The registered event type.

handler

JavaScriptFunction

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

captures

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

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

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

stationery

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

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

versionComments

The comment for this version. (Optional)

forceSave