Adobe InDesign CS6 Server (8.0) Object Model JS: Document

InDesign Server CS6

previous page next page

Class

Document

A document.

QuickLinks

addEventListener, align, changeComposer, changeGlyph, changeGrep, changeObject, changeText, changeTransliterate, checkIn, clearFrameFittingOptions, close, createAlternateLayout, createTOC, deleteAlternateLayout, deleteUnusedTags, distribute, embed, exportFile, exportStrokeStyles, extractLabel, findGlyph, findGrep, findObject, findText, findTransliterate, getElements, importAdobeSwatchbookProcessColor, importAdobeSwatchbookSpotColor, importDtd, importFormats, importStyles, importXML, insertLabel, loadConditions, loadMasters, loadSwatches, loadXMLTags, mapStylesToXMLTags, mapXMLTagsToStyles, packageForPrint, placeAndLink, print, printBooklet, recompose, removeEventListener, resetAllButtons, resetAllMultiStateObjects, revert, revertToProject, save, saveACopy, saveSwatches, saveXMLTags, synchronizeWithVersionCue, toSource, toSpecifier, updateCrossReferences

Hierarchy

Application

Document

Properties

Property	Type	Access	Description
accurateLABSpots	bool	r/w	If true, uses LAB alternates for spot colors when available.
activeLayer	Layer String	r/w	The active layer. Can also accept: String.
activeProcess	PreflightProcess	readonly	The active preflight process for this document.
afterBlendingIntent	RenderingIntent: RenderingIntent.USE_COLOR_SETTINGS RenderingIntent.PERCEPTUAL RenderingIntent.SATURATION RenderingIntent.RELATIVE_COLORIMETRIC RenderingIntent.ABSOLUTE_COLORIMETRIC	r/w	The rendering intent for colors that result from transparency interactions on the page after blending.
allCellStyles	Array of CellStyle	readonly	All Cell styles
allCharacterStyles	Array of CharacterStyle	readonly	Lists all character styles (regardless of their group).
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Document.
allObjectStyles	Array of ObjectStyle	readonly	All object styles contained by the Document.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Document.
allParagraphStyles	Array of ParagraphStyle	readonly	Lists all paragraph styles (regardless of their group).
allTableStyles	Array of TableStyle	readonly	All Table styles
anchoredObjectDefaults	AnchoredObjectDefault	readonly	Anchored object default settings.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
articles	Articles Article	readonly	A collection of articles.
assignments	Assignments Assignment	readonly	A collection of assignments.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Document.
baselineFrameGridOptions	BaselineFrameGridOption	readonly	Baseline frame grid option settings.
bookmarks	Bookmarks Bookmark	readonly	A collection of bookmarks.
buttonPreferences	ButtonPreference	readonly	Button preference settings.
buttons	Buttons Button	readonly	A collection of buttons.
cellStyleGroups	CellStyleGroups CellStyleGroup	readonly	A collection of cell style groups.
cellStyleMappings	CellStyleMappings CellStyleMapping	readonly	A collection of cell style mappings.
cellStyles	CellStyles CellStyle	readonly	A collection of cell styles.
chapterNumberPreferences	ChapterNumberPreference	readonly	Chapter numbering preferences.
charStyleMappings	CharStyleMappings CharStyleMapping	readonly	A collection of char style mappings.
characterStyleGroups	CharacterStyleGroups CharacterStyleGroup	readonly	A collection of character style groups.
characterStyles	CharacterStyles CharacterStyle	readonly	A collection of character styles.
checkBoxes	CheckBoxes	readonly	A collection of checkboxes.
cjkGridPreferences	CjkGridPreference	readonly	CJK grid preference settings.
cmykPolicy	ColorSettingsPolicy: ColorSettingsPolicy.COLOR_POLICY_OFF ColorSettingsPolicy.PRESERVE_EMBEDDED_PROFILES ColorSettingsPolicy.CONVERT_TO_WORKING_SPACE ColorSettingsPolicy.COMBINATION_OF_PRESERVE_AND_SAFE_CMYK	r/w	The policy for handling colors in a CMYK color model, including reading and embedding color profiles, mismatches between embedded color profiles and the working space, and moving colors from one document to another.
cmykProfile	string	r/w	The current CMYK profile.
cmykProfileList	Array of string	readonly	A list of valid CMYK profiles.
colors	Colors Color	readonly	A collection of colors.
comboBoxes	ComboBoxes	readonly	A collection of comboboxes.
compositeFonts	CompositeFonts CompositeFont	readonly	A collection of composite fonts.
conditionSets	ConditionSets ConditionSet	readonly	A collection of condition sets for conditional text.
conditionalTextPreferences	ConditionalTextPreference	readonly	Conditional text preferences.
conditions	Conditions Condition	readonly	A collection of conditions for conditional text.
converted	bool	readonly	If true, the Document was converted.
crossReferenceFormats	CrossReferenceFormats CrossReferenceFormat	readonly	A collection of cross reference formats.
crossReferenceSources	CrossReferenceSources CrossReferenceSource	readonly	A collection of cross reference text sources.
dashedStrokeStyles	DashedStrokeStyles DashedStrokeStyle	readonly	A collection of dashed stroke styles.
dataMergeImagePlaceholders	DataMergeImagePlaceholders DataMergeImagePlaceholder	readonly	A collection of data merge image placeholders.
dataMergeOptions	DataMergeOption	readonly	The data merge option properties that define the data merge.
dataMergeProperties	DataMerge	readonly	Data merge properties that define data merge fields and preferences.
dataMergeTextPlaceholders	DataMergeTextPlaceholders DataMergeTextPlaceholder	readonly	A collection of data merge text placeholders.
defaultImageIntent	RenderingIntent: RenderingIntent.USE_COLOR_SETTINGS RenderingIntent.PERCEPTUAL RenderingIntent.SATURATION RenderingIntent.RELATIVE_COLORIMETRIC RenderingIntent.ABSOLUTE_COLORIMETRIC	r/w	The rendering intent for bitmap images.
dictionaryPreferences	DictionaryPreference	readonly	User dictionary preference settings.
documentPreferences	DocumentPreference	readonly	Document preference settings.
dottedStrokeStyles	DottedStrokeStyles DottedStrokeStyle	readonly	A collection of dotted stroke styles.
dtds	DTDs DTD	readonly	A collection of DTDs.
editingState	EditingState: EditingState.EDITING_UNKNOWN EditingState.EDITING_NOWHERE EditingState.EDITING_REMOTELY EditingState.EDITING_LOCALLY EditingState.EDITING_LOCALLY_LOCKED EditingState.EDITING_CONFLICT	readonly	The Version Cue editing state of the file.
epstexts	EPSTexts EPSText	readonly	EPSTexts
epubExportPreferences	EPubExportPreference	readonly	EPub export preference settings.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
exportForWebPreferences	ExportForWebPreference	readonly	The default export for web preferences.
filePath	File	readonly	The full path to the file.
fonts	Fonts Font	readonly	A collection of fonts.
footnoteOptions	FootnoteOption	readonly	Footnote option settings.
formFields	FormFields FormField	readonly	A collection of form fields.
frameFittingOptions	FrameFittingOption	readonly	The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
fullName	File	readonly	The full path to the Document, including the name of the Document.
gradients	Gradients Gradient	readonly	A collection of gradients.
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
gridPreferences	GridPreference	readonly	Grid preference settings.
groups	Groups Group	readonly	A collection of groups.
guidePreferences	GuidePreference	readonly	Guide preference settings.
guides	Guides Guide	readonly	A collection of guides.
htmlExportPreferences	HTMLExportPreference	readonly	HTML export preference settings.
hyperlinkExternalPageDestinations	HyperlinkExternalPageDestinations HyperlinkExternalPageDestination	readonly	A collection of hyperlink external page destinations.
hyperlinkPageDestinations	HyperlinkPageDestinations HyperlinkPageDestination	readonly	A collection of hyperlink page destinations.
hyperlinkPageItemSources	HyperlinkPageItemSources HyperlinkPageItemSource	readonly	A collection of hyperlink page item sources.
hyperlinkTextDestinations	HyperlinkTextDestinations HyperlinkTextDestination	readonly	A collection of hyperlink text destinations.
hyperlinkTextSources	HyperlinkTextSources HyperlinkTextSource	readonly	A collection of hyperlink text sources.
hyperlinkURLDestinations	HyperlinkURLDestinations HyperlinkURLDestination	readonly	A collection of hyperlink URL destinations.
hyperlinks	Hyperlinks Hyperlink	readonly	A collection of hyperlinks.
hyphenationExceptions	HyphenationExceptions HyphenationException	readonly	A collection of hyphenation exceptions lists.
id	number	readonly	The unique ID of the Document.
index	number	readonly	The index of the Document within its containing object.
indexGenerationOptions	IndexOptions	readonly	The index options properties that define how an index is formatted.
indexes	Indexes	readonly	A collection of indexes.
indexingSortOptions	IndexingSortOptions IndexingSortOption	readonly	A collection of indexing sort options.
inks	Inks Ink	readonly	A collection of inks.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
kinsokuTables	KinsokuTables KinsokuTable	readonly	A collection of kinsoku tables.
label	string	r/w	A property that can be set to any string.
languages	Languages Language	readonly	A collection of languages.
layers	Layers Layer	readonly	A collection of layers.
layoutAdjustmentPreferences	LayoutAdjustmentPreference	readonly	Layout sdjustment preference settings.
layoutGridData	LayoutGridDataInformation	readonly	Default properties specific to layout grids.
linkedPageItemOptions	LinkedPageItemOption	readonly	Linked Page Item options
linkedStoryOptions	LinkedStoryOption	readonly	Linked story options
links	Links Link	readonly	A collection of links.
listBoxes	ListBoxes	readonly	A collection of listboxes.
marginPreferences	MarginPreference	readonly	Margin preference settings.
masterSpreads	MasterSpreads MasterSpread	readonly	A collection of master spreads.
metadataPreferences	MetadataPreference	readonly	Metadata preference settings.
mixedInkGroups	MixedInkGroups MixedInkGroup	readonly	A collection of mixed ink groups.
mixedInks	MixedInks MixedInk	readonly	A collection of mixed inks.
modified	bool	readonly	If true, the Document has been modified since it was last saved.
mojikumiTables	MojikumiTables MojikumiTable	readonly	A collection of mojikumi tables.
mojikumiUIPreferences	MojikumiUiPreference	readonly	Mojikumi user interface preference settings.
motionPresets	MotionPresets MotionPreset	readonly	A collection of Motion presets.
multiStateObjects	MultiStateObjects MultiStateObject	readonly	A collection of multi-state objects.
name	string	readonly	The name of the Document.
namedGrids	NamedGrids NamedGrid	readonly	A collection of named grids.
numberingLists	NumberingLists NumberingList	readonly	A collection of numbered lists.
objectStyleGroups	ObjectStyleGroups ObjectStyleGroup	readonly	A collection of object style groups.
objectStyles	ObjectStyles ObjectStyle	readonly	A collection of object styles.
ovals	Ovals Oval	readonly	A collection of ellipses.
pageItemDefaults	PageItemDefault	readonly	The default page item formatting for the Document.
pageItems	PageItems PageItem	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
pages	Pages Page	readonly	A collection of pages.
paraStyleMappings	ParaStyleMappings ParaStyleMapping	readonly	A collection of para style mappings.
paragraphDestinations	ParagraphDestinations ParagraphDestination	readonly	A collection of paragraph destinations.
paragraphStyleGroups	ParagraphStyleGroups ParagraphStyleGroup	readonly	A collection of paragraph style groups.
paragraphStyles	ParagraphStyles ParagraphStyle	readonly	A collection of paragraph styles.
parent	Application	readonly	The parent of the Document (a Application).
pasteboardPreferences	PasteboardPreference	readonly	Pasteboard preference settings.
placeGuns	PlaceGun	readonly	The place gun.
polygons	Polygons Polygon	readonly	A collection of polygons.
preferences	Preferences Preference	readonly	A collection of preferences objects.
preflightOptions	PreflightOption	readonly	Preflight option settings.
preflightProfiles	PreflightProfiles PreflightProfile	readonly	A collection of preflight profiles.
printBookletOptions	PrintBookletOption	readonly	Booklet printing options.
printBookletPrintPreferences	PrintBookletPrintPreference	readonly	Print booklet preferences.
printPreferences	PrintPreference	readonly	Print preference settings.
properties	Object	r/w	A property that allows setting of several properties at the same time.
radioButtons	RadioButtons RadioButton	readonly	A collection of radio buttons.
readOnly	bool	readonly	If true, the Document is read-only.
recovered	bool	readonly	If true, the Document was recovered.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
rgbPolicy	ColorSettingsPolicy: ColorSettingsPolicy.COLOR_POLICY_OFF ColorSettingsPolicy.PRESERVE_EMBEDDED_PROFILES ColorSettingsPolicy.CONVERT_TO_WORKING_SPACE ColorSettingsPolicy.COMBINATION_OF_PRESERVE_AND_SAFE_CMYK	r/w	The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another.
rgbProfile	string	r/w	The current RGB profile.
rgbProfileList	Array of string	readonly	A list of valid RGB profiles.
saved	bool	readonly	If true, the Document has been saved since it was created.
sections	Sections Section	readonly	A collection of sections.
signatureFields	SignatureFields SignatureField	readonly	A collection of signature fields.
solidColorIntent	RenderingIntent: RenderingIntent.USE_COLOR_SETTINGS RenderingIntent.PERCEPTUAL RenderingIntent.SATURATION RenderingIntent.RELATIVE_COLORIMETRIC RenderingIntent.ABSOLUTE_COLORIMETRIC	r/w	The rendering intent for all vector art (areas of solid color) in native objects.
splineItems	SplineItems SplineItem	readonly	The spline items collection.
spreads	Spreads Spread	readonly	A collection of spreads.
stories	Stories Story	readonly	A collection of stories.
storyGridData	StoryGridDataInformation	readonly	Default properties specific to frame grids.
storyPreferences	StoryPreference	readonly	Story preference settings.
stripedStrokeStyles	StripedStrokeStyles StripedStrokeStyle	readonly	A collection of striped stroke styles.
strokeStyles	StrokeStyles StrokeStyle	readonly	A collection of stroke styles.
swatches	Swatches	readonly	A collection of swatches.
tableStyleGroups	TableStyleGroups TableStyleGroup	readonly	A collection of table style groups.
tableStyleMappings	TableStyleMappings TableStyleMapping	readonly	A collection of table style mappings.
tableStyles	TableStyles TableStyle	readonly	A collection of table styles.
taggedPDFPreferences	TaggedPDFPreference	readonly	Tagged PDF preferences.
textBoxes	TextBoxes	readonly	A collection of text boxes.
textDefaults	TextDefault	readonly	Text default settings.
textFramePreferences	TextFramePreference	readonly	Text frame preference settings.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textPreferences	TextPreference	readonly	Text preference settings.
textVariables	TextVariables TextVariable	readonly	A collection of text variables.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
tints	Tints Tint	readonly	A collection of tints.
tocStyles	TOCStyles TOCStyle	readonly	A collection of TOC styles.
transparencyPreferences	TransparencyPreference	readonly	Transparency preference settings.
trapPresets	TrapPresets TrapPreset	readonly	A collection of trap presets.
unusedSwatches	Array of Swatch	readonly	The swatches that are not being used.
validationErrors	ValidationErrors ValidationError	readonly	A collection of XML validation errors.
versionState	VersionState: VersionState.VERSION_UNKNOWN VersionState.PROJECT_FILE_NEWER VersionState.LOCAL_PROJECT_MATCH VersionState.LOCAL_NEWER VersionState.VERSION_CONFLICT VersionState.NO_RESOURCE	readonly	The Version Cue version state of the file.
viewPreferences	ViewPreference	readonly	View preference settings.
visible	bool	readonly	If true, the Document is visible.
watermarkPreferences	WatermarkPreference	readonly	Watermark preferences
xmlComments	XMLComments XMLComment	readonly	A collection of XML comments.
xmlElements	XMLElements XMLElement	readonly	A collection of XML elements.
xmlExportMaps	XMLExportMaps XMLExportMap	readonly	A collection of XML export maps.
xmlExportPreferences	XMLExportPreference	readonly	XML export preference settings.
xmlImportMaps	XMLImportMaps XMLImportMap	readonly	A collection of XML import maps.
xmlImportPreferences	XMLImportPreference	readonly	XML import preference settings.
xmlInstructions	XMLInstructions XMLInstruction	readonly	A collection of XML instructions.
xmlItems	XMLItems XMLItem	readonly	A collection of XML items.
xmlPreferences	XMLPreference	readonly	The XML preference settings.
xmlStories	XmlStories XmlStory	readonly	A collection of xml stories.
xmlTags	XMLTags XMLTag	readonly	A collection of XML tags.
zeroPoint	Array of Measurement Unit (Number or String)	r/w	The ruler origin, specified as page coordinates in the format [x, y].

Class

Property	Type	Access	Description
AFTER_EXPORT	string	readonly	Dispatched after a Document is exported. This event bubbles. This event is not cancelable. (default: afterExport)
AFTER_IMPORT	string	readonly	Dispatched after importing a file into a Document. This event bubbles. This event is not cancelable. (default: afterImport)
AFTER_LINKS_CHANGED	string	readonly	Dispatched after one or more links in the Document have been added, deleted, or modified. This event bubbles. This event is not cancelable. (default: afterLinksChanged)
AFTER_NEW	string	readonly	Dispatched after a Document is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_OPEN	string	readonly	Dispatched after a Document is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_PRINT	string	readonly	Dispatched after a Document is printed. This event bubbles. This event is not cancelable. (default: afterPrint)
AFTER_REVERT	string	readonly	Dispatched after a Document is reverted. This event bubbles. This event is not cancelable. (default: afterRevert)
AFTER_SAVE	string	readonly	Dispatched after a Document is saved. This event bubbles. This event is not cancelable. (default: afterSave)
AFTER_SAVE_AS	string	readonly	Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable. (default: afterSaveAs)
AFTER_SAVE_A_COPY	string	readonly	Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable. (default: afterSaveACopy)
BEFORE_CLOSE	string	readonly	Dispatched before a Document is closed. This event bubbles. This event is not cancelable. (default: beforeClose)
BEFORE_EXPORT	string	readonly	Dispatched before a Document is exported. This event bubbles. This event is cancelable. (default: beforeExport)
BEFORE_IMPORT	string	readonly	Dispatched before importing a file into a Document. This event bubbles. This event is cancelable. (default: beforeImport)
BEFORE_PRINT	string	readonly	Dispatched before a Document is printed. This event bubbles. This event is cancelable. (default: beforePrint)
BEFORE_REVERT	string	readonly	Dispatched before a Document is reverted. This event bubbles. This event is cancelable. (default: beforeRevert)
BEFORE_SAVE	string	readonly	Dispatched before a Document is saved. This event bubbles. This event is cancelable. (default: beforeSave)
BEFORE_SAVE_AS	string	readonly	Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable. (default: beforeSaveAs)
BEFORE_SAVE_A_COPY	string	readonly	Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable. (default: beforeSaveACopy)
FAILED_EXPORT	string	readonly	Dispatched after a Document export is canceled or fails. This event bubbles. This event is not cancelable. (default: failedExport)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void 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.LEFT_EDGES AlignOptions.TOP_EDGES AlignOptions.RIGHT_EDGES AlignOptions.BOTTOM_EDGES AlignOptions.HORIZONTAL_CENTERS AlignOptions.VERTICAL_CENTERS	The type of alignment to apply.
alignDistributeBounds	AlignDistributeBounds: AlignDistributeBounds.ITEM_BOUNDS AlignDistributeBounds.PAGE_BOUNDS AlignDistributeBounds.MARGIN_BOUNDS AlignDistributeBounds.SPREAD_BOUNDS AlignDistributeBounds.KEY_OBJECT	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)

void changeComposer ()
Change comoser to optyca

Array of Text changeGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value and replaces the glyphs with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeGrep ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeText ([reverseOrder: bool])
Finds text that matches the find what value and replaces the text with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text changeTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value and replaces the text with the change character type value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void checkIn ([versionComments: string][, forceSave: bool=false])
Check in to Version Cue.

Parameter	Type	Description
versionComments	string	The comment for this version (Optional)
forceSave	bool	Forcibly save a version (Optional) (default: false)

void clearFrameFittingOptions ()
Removes the frame fittings options and resets it to the initial state.

void close ([saving: SaveOptions=SaveOptions.NO][, savingIn: File][, versionComments: string][, forceSave: bool=false])
Close the Document

Parameter	Type	Description
saving	SaveOptions: SaveOptions.NO SaveOptions.YES	Whether to save changes before closing the Document (Optional) (default: SaveOptions.NO)
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) (default: false)

void createAlternateLayout (spreadItems: Array of Spread, name: string, width: Measurement Unit (Number or String), height: Measurement Unit (Number or String), createTextStyles: bool, linkTextStories: bool, 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	Measurement Unit (Number or String)	The width of the pages created.
height	Measurement Unit (Number or String)	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: LayoutRuleOptions.OFF LayoutRuleOptions.SCALE LayoutRuleOptions.RECENTER LayoutRuleOptions.GUIDE_BASED LayoutRuleOptions.OBJECT_BASED LayoutRuleOptions.USE_MASTER LayoutRuleOptions.PRESERVE_EXISTING	What layout rule to set on the pages.

Array of Story createTOC (using: TOCStyle[, replacing: bool=false][, fromBook: Book][, placePoint: Array of Measurement Unit (Number or String)][, includeOverset: bool=false][, 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	bool	If true, replaces the existing TOC. (Optional) (default: false)
fromBook	Book	The book whose documents to include in the TOC. (Optional)
placePoint	Array of Measurement Unit (Number or String)	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) (default: false)
destinationLayer	Layer	The layer on which to place the TOC. (Optional)

void deleteAlternateLayout (name: string)
Deletes an alternate layout.

Parameter	Type	Description
name	string	The name of the alternate layout to delete.

void deleteUnusedTags ()
Deletes unused XML markup tags.

void distribute (alignDistributeItems: Array of PageItem, distributeOption: DistributeOptions[, alignDistributeBounds: AlignDistributeBounds][, useDistributeMeasurement: bool][, absoluteDistributeMeasurement: Measurement Unit (Number or String)][, reference: PageItem])
Distribute page items.

Parameter	Type	Description
alignDistributeItems	Array of PageItem	The page items to align or distribute
distributeOption	DistributeOptions: DistributeOptions.LEFT_EDGES DistributeOptions.TOP_EDGES DistributeOptions.RIGHT_EDGES DistributeOptions.BOTTOM_EDGES DistributeOptions.HORIZONTAL_CENTERS DistributeOptions.VERTICAL_CENTERS DistributeOptions.HORIZONTAL_SPACE DistributeOptions.VERTICAL_SPACE	The type of distribution to apply.
alignDistributeBounds	AlignDistributeBounds: AlignDistributeBounds.ITEM_BOUNDS AlignDistributeBounds.PAGE_BOUNDS AlignDistributeBounds.MARGIN_BOUNDS AlignDistributeBounds.SPREAD_BOUNDS AlignDistributeBounds.KEY_OBJECT	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)	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)
Embed this profile to the document.

Parameter	Type	Description
using	PreflightProfile String	The preflight profile to embed. Can accept: String or PreflightProfile.

void exportFile (format: varies, to: File[, using: PDFExportPreset][, withGrids: bool=false][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat 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.
using	PDFExportPreset	The export style. (Optional)
withGrids	bool	If true, exports the grids. (Optional) (default: false)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

void exportStrokeStyles (to: File, strokeStyleList: Array of StrokeStyle[, versionComments: string][, forceSave: bool=false])
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	bool	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.

Array of Text findGlyph ([reverseOrder: bool])
Finds glyphs that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findGrep ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findText ([reverseOrder: bool])
Finds text that matches the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Text findTransliterate ([reverseOrder: bool])
Finds text that matches the find character type value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

Array of Document getElements ()
Resolves the object specifier, creating an array of object references.

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.

void importDtd (from: File)
Imports a DTD to use for validation.

Parameter	Type	Description
from	File	The path to the DTD file.

void importFormats (from: File)
Imports the cross reference formats from specified file.

Parameter	Type	Description
from	File	The file whose formats to import.

void importStyles (format: ImportFormat, from: File[, globalStrategy: GlobalClashResolutionStrategy=GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE])
Imports the specified styles.

Parameter	Type	Description
format	ImportFormat: ImportFormat.CHARACTER_STYLES_FORMAT ImportFormat.PARAGRAPH_STYLES_FORMAT ImportFormat.TEXT_STYLES_FORMAT ImportFormat.TOC_STYLES_FORMAT ImportFormat.NAMED_GRIDS_FORMAT ImportFormat.OBJECT_STYLES_FORMAT ImportFormat.STROKE_STYLES_FORMAT ImportFormat.TABLE_STYLES_FORMAT ImportFormat.CELL_STYLES_FORMAT ImportFormat.TABLE_AND_CELL_STYLES_FORMAT	The types of styles to import.
from	File	The file containing the styles you want to import.
globalStrategy	GlobalClashResolutionStrategy: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE GlobalClashResolutionStrategy.LOAD_ALL_WITH_RENAME GlobalClashResolutionStrategy.DO_NOT_LOAD_THE_STYLE	The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) (default: GlobalClashResolutionStrategy.LOAD_ALL_WITH_OVERWRITE)

void importXML (from: File)
Imports the specified XML file into an InDesign document.

Parameter	Type	Description
from	File	The XML file.

void 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.

void loadConditions (from: File[, loadConditionSets: bool])
Load conditions from the specified file.

Parameter	Type	Description
from	File	The path to the file that contains the conditions.
loadConditionSets	bool	If true, load the condition sets as well. (Optional)

void loadMasters (from: File[, globalStrategyForMasterPage: GlobalClashResolutionStrategyForMasterPage=GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE])
Load masterpages from an InDesign file.

Parameter	Type	Description
from	File	The InDesign file to load the masters from.
globalStrategyForMasterPage	GlobalClashResolutionStrategyForMasterPage: GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_RENAME	the global clash resolution strategy for load master page (Optional) (default: GlobalClashResolutionStrategyForMasterPage.LOAD_ALL_WITH_OVERWRITE)

void loadSwatches (from: File)
Load swatches from the specified file.

Parameter	Type	Description
from	File	The swatch file or InDesign document.

void 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.

void mapStylesToXMLTags ()
Auto tag the document based on the style to tag mappings

void mapXMLTagsToStyles ()
Auto style the document based on the tag to style mappings

bool packageForPrint (to: File, copyingFonts: bool, copyingLinkedGraphics: bool, copyingProfiles: bool, updatingGraphics: bool, includingHiddenLayers: bool, ignorePreflightErrors: bool, creatingReport: bool[, versionComments: string][, forceSave: bool=false])
Packages the document.

Parameter	Type	Description
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.
versionComments	string	The comments for the version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

void placeAndLink (parentStory: Story[, showingOptions: bool=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.

Parameter	Type	Description
parentStory	Story	The story to place and link from.
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

void print ([using: varies][, withGrids: bool=false])
Prints the Document(s).

Parameter	Type	Description
using	PrinterPreset PrinterPresetTypes	Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)
withGrids	bool	Whether to print grids (Optional) (default: false)

void printBooklet ([using: varies])
Print the Booklet using current document and Booklet and Print settings in the document

Parameter	Type	Description
using	PrinterPreset PrinterPresetTypes	Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

void recompose ()
Recomposes the text in the Document.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void resetAllButtons ()
Resets all the buttons to their Normal state.

void resetAllMultiStateObjects ()
Resets all the multi-state objects to their first state.

bool revert ()
Reverts the document to its state at the last save operation.

void revertToProject ([forceRevert: bool=false])
Reverts to the version of the document in Version Cue.

Parameter	Type	Description
forceRevert	bool	Forcibly reverts to the project version. (Optional) (default: false)

Document save ([to: File][, stationery: bool=false][, versionComments: string][, forceSave: bool=false])
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	bool	Whether to save the file as stationery (Optional) (default: false)
versionComments	string	The comment for this version (Optional)
forceSave	bool	Forcibly save a version (Optional) (default: false)

void saveACopy ([to: File][, stationery: bool=false])
Saves a copy of the document.

Parameter	Type	Description
to	File	The file path for the copy. Note: Leaves the original document open and does not open the copy. (Optional)
stationery	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) (default: false)

void saveSwatches (to: File, swatchList: Array of Swatch[, versionComments: string][, forceSave: bool=false])
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	bool	If true, forcibly saves a version. (Optional) (default: false)

void saveXMLTags (to: File[, versionComments: string][, forceSave: bool=false])
Saves a set of tags to an external file.

Parameter	Type	Description
to	File	The full path to the file in which to save the tags.
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

VersionCueSyncStatus synchronizeWithVersionCue ([syncConflictResolution: SyncConflictResolution=SyncConflictResolution.SKIP_CONFLICTS][, versionComments: string])
Synchronizes the file with the Version Cue project.

Parameter	Type	Description
syncConflictResolution	SyncConflictResolution: SyncConflictResolution.SKIP_CONFLICTS SyncConflictResolution.ASK_ABOUT_CONFLICTS SyncConflictResolution.PREFER_LOCAL SyncConflictResolution.PREFER_PROJECT	The conflict resolution method to use during synchronization. (Optional) (default: SyncConflictResolution.SKIP_CONFLICTS)
versionComments	string	The comments that describe the version. (Optional)