InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

Document

A document.

Hierarchy

Application

Document

78 objects

Article | Assignment | Bookmark | CellStyle | CellStyleGroup | CellStyleMapping | CharStyleMapping | CharacterStyle | CharacterStyleGroup | Color | ColorGroup | CompositeFont | Condition | ConditionSet | CrossReferenceFormat | CrossReferenceSource | DTD | DashedStrokeStyle | DataMergeImagePlaceholder | DataMergeQrcodePlaceholder | DataMergeTextPlaceholder | DocumentEvent | DottedStrokeStyle | Font | Gradient | Hyperlink | HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkPageItemSource | HyperlinkTextDestination | HyperlinkTextSource | HyperlinkURLDestination | HyphenationException | ImportExportEvent | Index_ | IndexingSortOption | Ink | KinsokuTable | Language | Layer | MasterSpread | MixedInk | MixedInkGroup | MojikumiTable | MotionPreset | NamedGrid | NumberingList | ObjectStyle | ObjectStyleGroup | PDFComment | ParaStyleMapping | ParagraphDestination | ParagraphStyle | ParagraphStyleGroup | PreflightProfile | PrintEvent | Section | Spread | Story | StripedStrokeStyle | StrokeStyle | Swatch | TOCStyle | TableStyle | TableStyleGroup | TableStyleMapping | TextVariable | Tint | TrapPreset | ValidationError | XMLComment | XMLElement | XMLExportMap | XMLImportMap | XMLInstruction | XMLItem | XMLTag | XmlStory

51 preference objects

AdjustLayoutPreference | AnchoredObjectDefault | AnchoredObjectSetting | BaselineFrameGridOption | ButtonPreference | ChapterNumberPreference | CjkGridPreference | ConditionalTextPreference | DataMerge | DataMergeOption | DictionaryPreference | DocumentPreference | EPubExportPreference | EPubFixedLayoutExportPreference | EndnoteOption | ExportForWebPreference | FootnoteOption | FrameFittingOption | GridPreference | GuidePreference | HTMLExportPreference | HTMLFXLExportPreference | IndexOptions | LayoutGridDataInformation | LinkedPageItemOption | LinkedStoryOption | MarginPreference | MetadataPreference | MojikumiUiPreference | PageItemDefault | PasteboardPreference | PlaceGun | Preference | PreflightOption | PrintBookletOption | PrintBookletPrintPreference | PrintPreference | PublishExportPreference | StoryGridDataInformation | StoryPreference | TaggedPDFPreference | TextDefault | TextFramePreference | TextPreference | TextWrapPreference | TransparencyPreference | ViewPreference | WatermarkPreference | XMLExportPreference | XMLImportPreference | XMLPreference

Properties

NameType AccessDescription
Boolean read/write If true, uses LAB alternates for spot colors when available.
Layer | String read/write The active layer. Can also accept: String.
PreflightProcess readonly The active preflight process for this document.
AdjustLayoutPreference readonly Adjust layout preference settings.
RenderingIntent
 read/write The rendering intent for colors that result from transparency interactions on the page after blending.
CellStyle[] readonly All Cell styles
CharacterStyle[] readonly Lists all character styles (regardless of their group).
Graphic[] readonly Lists all graphics contained by the Document.
ObjectStyle[] readonly All object styles contained by the Document.
PageItem[] readonly Lists all page items contained by the Document.
ParagraphStyle[] readonly Lists all paragraph styles (regardless of their group).
TableStyle[] readonly All Table styles
AnchoredObjectDefault readonly Anchored object default settings.
AnchoredObjectSetting readonly Anchored object settings.
Number read/write The font size (in points) for Math objects
Number[] read/write RGB Color applied on the math object specified in 0-255 range.
String | Swatch | NothingEnum
 read/write The swatch used for math object color. Also accepts swatch name.(RGB, CMYK, LAB and HSB swatches supported.). Can return: Swatch or NothingEnum enumerator. Can also accept: String.
Articles<Article> readonly A collection of articles.
Assignments<Assignment> readonly A collection of assignments.
XMLItem readonly The XML element associated with the Document.
BaselineFrameGridOption readonly Baseline frame grid option settings.
Bookmarks<Bookmark> readonly A collection of bookmarks.
ButtonPreference readonly Button preference settings.
Buttons<Button> readonly A collection of buttons.
CellStyleGroups<CellStyleGroup> readonly A collection of cell style groups.
CellStyleMappings<CellStyleMapping> readonly A collection of cell style mappings.
CellStyles<CellStyle> readonly A collection of cell styles.
ChapterNumberPreference readonly Chapter numbering preferences.
CharStyleMappings<CharStyleMapping> readonly A collection of char style mappings.
CharacterStyleGroups<CharacterStyleGroup> readonly A collection of character style groups.
CharacterStyles<CharacterStyle> readonly A collection of character styles.
CheckBoxes<CheckBox> readonly A collection of checkboxes.
CjkGridPreference readonly CJK grid preference settings.
ColorSettingsPolicy
 read/write The policy for handling colors in a CMYK color model, including reading and embedding color profiles, mismatches between embedded color profiles and the working space, and moving colors from one document to another.
String read/write The current CMYK profile.
String[] readonly A list of valid CMYK profiles.
ColorGroups<ColorGroup> readonly A collection of color groups.
Colors<Color> readonly A collection of colors.
ComboBoxes<ComboBox> readonly A collection of comboboxes.
CompositeFonts<CompositeFont> readonly A collection of composite fonts.
ConditionSets<ConditionSet> readonly A collection of condition sets for conditional text.
ConditionalTextPreference readonly Conditional text preferences.
Conditions<Condition> readonly A collection of conditions for conditional text.
Boolean readonly If true, the Document was converted.
CrossReferenceFormats<CrossReferenceFormat> readonly A collection of cross reference formats.
CrossReferenceSources<CrossReferenceSource> readonly A collection of cross reference text sources.
DashedStrokeStyles<DashedStrokeStyle> readonly A collection of dashed stroke styles.
DataMergeImagePlaceholders<DataMergeImagePlaceholder> readonly A collection of data merge image placeholders.
DataMergeOption readonly The data merge option properties that define the data merge.
DataMerge readonly Data merge properties that define data merge fields and preferences.
DataMergeQrcodePlaceholders<DataMergeQrcodePlaceholder> readonly A collection of data merge QR code placeholders.
DataMergeTextPlaceholders<DataMergeTextPlaceholder> readonly A collection of data merge text placeholders.
RenderingIntent
 read/write The rendering intent for bitmap images.
DictionaryPreference readonly User dictionary preference settings.
DocumentPreference readonly Document preference settings.
DottedStrokeStyles<DottedStrokeStyle> readonly A collection of dotted stroke styles.
DTDs<DTD> readonly A collection of DTDs.
EditingState
 readonly The Version Cue editing state of the file.
EndnoteOption readonly Endnote option settings.
EndnoteTextFrames<EndnoteTextFrame> readonly A collection of endnote text frames.
EPSTexts<EPSText> readonly EPSTexts
EPubExportPreference readonly EPub export preference settings.
EPubFixedLayoutExportPreference readonly EPub fixed layout export preference settings.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
ExportForWebPreference readonly The default export for web preferences.
Folder readonly The path to the folder containing the document.
Fonts<Font> readonly A collection of fonts.
FootnoteOption readonly Footnote option settings.
FormFields<FormField> readonly A collection of form fields.
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.
File readonly The full path to the Document, including the name of the Document.
Gradients<Gradient> readonly A collection of gradients.
GraphicLines<GraphicLine> readonly A collection of graphic lines.
GridPreference readonly Grid preference settings.
Groups<Group> readonly A collection of groups.
GuidePreference readonly Guide preference settings.
Guides<Guide> readonly A collection of guides.
HTMLExportPreference readonly HTML export preference settings.
HTMLFXLExportPreference readonly HTML FXL export preference settings.
HyperlinkExternalPageDestinations<HyperlinkExternalPageDestination> readonly A collection of hyperlink external page destinations.
HyperlinkPageDestinations<HyperlinkPageDestination> readonly A collection of hyperlink page destinations.
HyperlinkPageItemSources<HyperlinkPageItemSource> readonly A collection of hyperlink page item sources.
HyperlinkTextDestinations<HyperlinkTextDestination> readonly A collection of hyperlink text destinations.
HyperlinkTextSources<HyperlinkTextSource> readonly A collection of hyperlink text sources.
HyperlinkURLDestinations<HyperlinkURLDestination> readonly A collection of hyperlink URL destinations.
HyphenationExceptions<HyphenationException> readonly A collection of hyphenation exceptions lists.
Number readonly The unique ID of the Document.
Number readonly The index of the Document within its containing object.
IndexOptions readonly The index options properties that define how an index is formatted.
Indexes<Index_> readonly A collection of indexes.
IndexingSortOptions<IndexingSortOption> readonly A collection of indexing sort options.
Inks<Ink> readonly A collection of inks.
Boolean readonly If true, the document is a cloud document.
Boolean readonly Returns true if the object specifier resolves to valid objects.
KinsokuTables<KinsokuTable> readonly A collection of kinsoku tables.
String read/write A property that can be set to any string.
Languages<Language> readonly A collection of languages.
Layers<Layer> readonly A collection of layers.
LayoutGridDataInformation readonly Default properties specific to layout grids.
LinkedPageItemOption readonly Linked Page Item options
LinkedStoryOption readonly Linked story options
ListBoxes<ListBox> readonly A collection of listboxes.
MarginPreference readonly Margin preference settings.
MasterSpreads<MasterSpread> readonly A collection of master spreads.
MathObjects<MathObject> readonly A collection of math objects.
MetadataPreference readonly Metadata preference settings.
MixedInkGroups<MixedInkGroup> readonly A collection of mixed ink groups.
MixedInks<MixedInk> readonly A collection of mixed inks.
Boolean readonly If true, the Document has been modified since it was last saved.
MojikumiTables<MojikumiTable> readonly A collection of mojikumi tables.
MojikumiUiPreference readonly Mojikumi user interface preference settings.
MotionPresets<MotionPreset> readonly A collection of Motion presets.
Text[] readonly All MathZones in range; returns vector of Text objects for each MathZone
String read/write InMath Control Code class to use for new MathZones and math expressions; 'InDesign' or 'InMath4'
String readonly MathTools CUSTOM CFG folder path
Number readonly Version of MathTools doc format used in this document
Boolean readonly is MathTools enabled for this document
MultiStateObjects<MultiStateObject> readonly A collection of multi-state objects.
String read/write The name of the Document.
NamedGrids<NamedGrid> readonly A collection of named grids.
NumberingLists<NumberingList> readonly A collection of numbered lists.
ObjectStyleGroups<ObjectStyleGroup> readonly A collection of object style groups.
ObjectStyles<ObjectStyle> readonly A collection of object styles.
Ovals<Oval> readonly A collection of ellipses.
PageItemDefault readonly The default page item formatting for the Document.
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<Page> readonly A collection of pages.
ParaStyleMappings<ParaStyleMapping> readonly A collection of para style mappings.
ParagraphDestinations<ParagraphDestination> readonly A collection of paragraph destinations.
ParagraphStyleGroups<ParagraphStyleGroup> readonly A collection of paragraph style groups.
ParagraphStyles<ParagraphStyle> readonly A collection of paragraph styles.
Application readonly The parent of the Document (a Application).
PasteboardPreference readonly Pasteboard preference settings.
PDFComments<PDFComment> readonly A collection of PDF comment objects
PlaceGun readonly The place gun.
Polygons<Polygon> readonly A collection of polygons.
Boolean read/write Preference to export math objects as MathML or SVG in EPUB export.
Preferences<Preference> readonly A collection of preferences objects.
PreflightOption readonly Preflight option settings.
PreflightProfiles<PreflightProfile> readonly A collection of preflight profiles.
PrintBookletOption readonly Booklet printing options.
PrintBookletPrintPreference readonly Print booklet preferences.
PrintPreference readonly Print preference settings.
Object read/write A property that allows setting of several properties at the same time.
PublishExportPreference readonly Publish export preference settings.
RadioButtons<RadioButton> readonly A collection of radio buttons.
Boolean readonly If true, the Document is read-only.
Boolean readonly If true, the Document was recovered.
Rectangles<Rectangle> readonly A collection of rectangles.
ColorSettingsPolicy
 read/write The policy for handling colors in an RGB color model, including reading and embedding color profiles, handling mismatches between embedded color profiles and the working space, and moving colors from one document to another.
String read/write The current RGB profile.
String[] readonly A list of valid RGB profiles.
Boolean readonly If true, the Document has been saved since it was created.
Sections<Section> readonly A collection of sections.
SignatureFields<SignatureField> readonly A collection of signature fields.
RenderingIntent
 read/write The rendering intent for all vector art (areas of solid color) in native objects.
SplineItems<SplineItem> readonly The spline items collection.
Spreads<Spread> readonly A collection of spreads.
Stories<Story> readonly A collection of stories.
StoryGridDataInformation readonly Default properties specific to frame grids.
StoryPreference readonly Story preference settings.
StripedStrokeStyles<StripedStrokeStyle> readonly A collection of striped stroke styles.
StrokeStyles<StrokeStyle> readonly A collection of stroke styles.
Swatches<Swatch> readonly A collection of swatches.
TableStyleGroups<TableStyleGroup> readonly A collection of table style groups.
TableStyleMappings<TableStyleMapping> readonly A collection of table style mappings.
TableStyles<TableStyle> readonly A collection of table styles.
TaggedPDFPreference readonly Tagged PDF preferences.
TextBoxes<TextBox> readonly A collection of text boxes.
TextDefault readonly Text default settings.
TextFramePreference readonly Text frame preference settings.
TextFrames<TextFrame> readonly A collection of text frames.
TextPreference readonly Text preference settings.
TextVariables<TextVariable> readonly A collection of text variables.
TextWrapPreference readonly The text wrap preference properties that define the default formatting for wrapping text around objects.
Number 0–100 read/write The percent of the base color. (Range: 0 to 100)
Tints<Tint> readonly A collection of tints.
TOCStyles<TOCStyle> readonly A collection of TOC styles.
TransparencyPreference readonly Transparency preference settings.
TrapPresets<TrapPreset> readonly A collection of trap presets.
Swatch[] readonly The swatches that are not being used.
ValidationErrors<ValidationError> readonly A collection of XML validation errors.
VersionState
 readonly The Version Cue version state of the file.
ViewPreference readonly View preference settings.
Boolean readonly If true, the Document is visible.
WatermarkPreference readonly Watermark preferences
XMLComments<XMLComment> readonly A collection of XML comments.
XMLElements<XMLElement> readonly A collection of XML elements.
XMLExportMaps<XMLExportMap> readonly A collection of XML export maps.
XMLExportPreference readonly XML export preference settings.
XMLImportMaps<XMLImportMap> readonly A collection of XML import maps.
XMLImportPreference readonly XML import preference settings.
XMLInstructions<XMLInstruction> readonly A collection of XML instructions.
XMLItems<XMLItem> readonly A collection of XML items.
XMLPreference readonly The XML preference settings.
XmlStories<XmlStory> readonly A collection of xml stories.
XMLTags<XMLTag> readonly A collection of XML tags.
Number[] | String[] unit read/write The ruler origin, specified as page coordinates in the format [x, y].

Events

NameDescription
Dispatched after a Document is exported. This event bubbles. This event is not cancelable.
Dispatched after importing a file into a Document. This event bubbles. This event is not cancelable.
Dispatched after a Document is created. This event bubbles. This event is not cancelable.
Dispatched after a Document is opened. This event bubbles. This event is not cancelable.
Dispatched after a Document is printed. This event bubbles. This event is not cancelable.
Dispatched after a Document is reverted. This event bubbles. This event is not cancelable.
Dispatched after a Document is saved. This event bubbles. This event is not cancelable.
Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.
Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.
Dispatched before a Document is closed. This event bubbles. This event is not cancelable.
Dispatched before a Document is exported. This event bubbles. This event is cancelable.
Dispatched before importing a file into a Document. This event bubbles. This event is cancelable.
Dispatched before a Document is printed. This event bubbles. This event is cancelable.
Dispatched before a Document is reverted. This event bubbles. This event is cancelable.
Dispatched before a Document is saved. This event bubbles. This event is cancelable.
Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.
Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.
Dispatched after a Document export is canceled or fails. This event bubbles. This event is not cancelable.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

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'})

adoptTo Object Change values - see functin definition for details
affectedPages? Page[] The collection of Page objects to affect (optional). Has no effect if function is called from Page
→ void

Align page items.

alignDistributeItems 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.
reference? PageItem The reference or key object to align to distribute relative to. Required when 'align distribute bounds' specifies 'key object'.
→ Number

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

→ void

Change comoser to optyca

→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.
→ PageItem[]

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

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

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

reverseOrder? Boolean If true, returns the results in reverse order.
→ void

Check in to Version Cue.

versionComments? String The comment for this version
forceSave? Boolean Forcibly save a version
→ void

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

→ void

Close the Document

saving? SaveOptions Whether to save changes before closing the Document
savingIn? File The file in which to save the Document
versionComments? String The comment for this version
forceSave? Boolean Forcibly save a version
→ Number[]

Transforms color values

colorValue Number[] source color value
sourceColorSpace ColorSpace source color space
destinationColorSpace ColorSpace destination color space
→ void

Creates an alternate layout for a given list of spreads.

spreadItems 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 unit The width of the pages created.
height Number | String unit 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 What layout rule to set on the pages.
→ void

Create Email QR Code on the page item or document

emailAddress? String QR code Email Address
subject? String QR code Email Subject
body? String QR code Email Body Message
qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.
withProperties? String[] Initial values for properties of the new Document. Above parameters can also be passed as properties
→ SVG

Creates a new object from MathML 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 Number[] | String[] unit The point where to place the object (only applicable if you are telling a page or spread to place)
→ void

Create Hyperlink QR Code on the page item or document

urlLink? String QR code Hyperlink URL
qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.
withProperties? String[] Initial values for properties of the new Document. Above parameters can also be passed as properties
→ void

Create Plain Text QR Code on the page item

plainText? String QR code Plain Text
qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.
withProperties? String[] Initial values for properties of the new Document. Above parameters can also be passed as properties
→ 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? Boolean If true, replaces the existing TOC.
fromBook? Book The book whose documents to include in the TOC.
placePoint? Number[] | String[] unit The point at which to place the TOC story, specified as page coordinates in the format [x, y].
includeOverset? Boolean If true, includes overset text TOC entries in the TOC.
destinationLayer? Layer The layer on which to place the TOC.
→ void

Create Text Msg QR Code on the page item or document

cellNumber? String QR code Text Phone Number
textMessage? String QR code Text Message
qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.
withProperties? String[] Initial values for properties of the new Document. Above parameters can also be passed as properties
→ void

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

firstName? String QR code Business Card First Name
lastName? String QR code Business Card Last Name
jobTitle? String QR code Business Card Title
cellPhone? String QR code Business Card Cell Phone Number
phone? String QR code Business Card Phone Number
email? String QR code Business Card Email Address
organisation? String QR code Business Card Organisation
streetAddress? String QR code Business Card Street Address
city? String QR code Business Card City
adrState? String QR code Business Card State
country? String QR code Business Card Country
postalCode? String QR code Business Card Postal Code
website? String QR code Business Card URL
qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.
withProperties? String[] Initial values for properties of the new Document. Above parameters can also be passed as properties
→ void

Deletes an alternate layout.

name String The name of the alternate layout to delete.
→ void

Deletes unused XML markup tags.

→ void

Distribute page items.

alignDistributeItems 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.
useDistributeMeasurement? Boolean If true, distribute space between page items. When this property is true, the bounds setting is ignored.
absoluteDistributeMeasurement? Number | String unit The distance to use when distributing page items. Required when 'align distribute bounds' specifies 'key object'.
reference? PageItem The reference or key object to align to distribute relative to. Required when 'align distribute bounds' specifies 'key object'.
→ void

Exports the object(s) to a file.

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.
withGrids? Boolean If true, exports the grids.
versionComments? String The comment for this version.
forceSave? Boolean If true, forcibly saves a version.
→ void

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

to File The path to the export file.
→ void

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

to File The path to the export file.
pageItemIds Number[] The array of the page item ids.
→ void

Exports stroke styles or presets.

to File The file to save to
strokeStyleList StrokeStyle[] The list of stroke styles to save
versionComments? String The comment for this version
forceSave? Boolean Forcibly save a version
→ String

Gets the label value associated with the specified key.

key String The key.
→ Number

Finds color that matches the find what value.

→ Text[]

Finds glyphs that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ PageItem[]

Finds objects that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Text[]

Finds text that matches the find character type value.

reverseOrder? Boolean If true, returns the results in reverse order.
→ Varies[]

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

resolveMaster? Boolean Resolves layout policy if setting is "use master" - default is true.
→ Document[]

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

→ void

Internal Use Only

resyncData String Internal Use Only
→ Color

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

name String The process color to load.
→ Color

Imports a spot color swatch from an Adobe color book.

name String The spot color to load.
→ void

Imports a DTD to use for validation.

from File The path to the DTD file.
→ void

Imports the cross reference formats from specified file.

from File The file whose formats to import.
→ void

Import Commemnts from PDF

from File The PDF File from which you want to import comments.
withProperties? Object Initial values for properties of the new Document
→ void

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

Imports the specified XML file into an InDesign document.

from File The XML file.
→ void

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

key String The key.
value String The value.
→ String

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

internalParameter1 String The first internal parameter
internalParameter2 String The second internal parameter
→ void

Load conditions from the specified file.

from File The path to the file that contains the conditions.
loadConditionSets? Boolean If true, load the condition sets as well.
→ void

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

Load swatches from the specified file.

from File The swatch file or InDesign document.
→ void

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

from File The path to the file that contains the tags.
→ void

Auto tag the document based on the style to tag mappings

→ void

Auto style the document based on the tag to style mappings

→ void

Cleanup after export MathZones as Inlines

exportFormat ExportFormat export format
fileToFix File exported file to fix MathML in
→ void

Cleanup after export MathZones as MathML

exportFormat ExportFormat export format
fileToFix File exported file to fix MathML in
→ void

Cleanup after export MathZones for PDF

→ void

convert a mt.editor V1 doc to MathTools V2

→ Varies

convert MTEF encoded image(s) into MathZone(s) on the given object (Story, Paragraph, Word, Character, Text, InsertionPoint) and return the resulting Text,Table,Cell object.

→ void

enable MathTools for given document and bootstrap the MathTemplates, MathStyle,...

→ File

creates temporary DOCX with equations prepared for importing by MathTools

origdocxfile File Original DOCX file to prepare
→ void

Prepare to export MathZones as Inlines

wrapOptions? Number 0x1=Clip, 0x2=EmitVA, 0x4=AltText
→ void

Prepare to export MathZones as MathML

→ void

Prepare to export MathZones for PDF

wrapOptions? Number 0x4=AltText, 0x8=TagAsArtifact
→ Boolean

Packages the document.

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.
includePdf? Boolean If true, generates and includes PDF in the package folder.
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.
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.
versionComments? String The comments for the version.
forceSave? Boolean If true, forcibly saves a version.
→ void

Prints the Document(s).

using? PrinterPresetTypes | PrinterPreset Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset.
withGrids? Boolean Whether to print grids
→ void

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

using? PrinterPresetTypes | PrinterPreset Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset.
→ void

Recomposes the text in the Document.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Resets all the buttons to their Normal state.

→ void

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

→ Boolean

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

→ void

Reverts to the version of the document in Version Cue.

forceRevert? Boolean Forcibly reverts to the project version.
→ 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
stationery? Boolean Whether to save the file as stationery
versionComments? String The comment for this version
forceSave? Boolean Forcibly save a version
→ void

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.
stationery? Boolean If true, saves the file as stationery (Mac OS) or as a template (Windows). Note: The file extension for stationery and templates is different than the extension for regular files.
→ void

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

to File The swatchbook file to save to.
swatchList Swatch[] The swatch(es) to save.
versionComments? String The comment for this version.
forceSave? Boolean If true, forcibly saves a version.
→ void

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.
forceSave? Boolean If true, forcibly saves a version.
→ VersionCueSyncStatus

Synchronizes the file with the Version Cue project.

syncConflictResolution? SyncConflictResolution The conflict resolution method to use during synchronization.
versionComments? String The comments that describe the version.
→ String

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

→ String

Retrieves the object specifier.

→ void

Updates cross references' text source content in the document.

Object of 134

Properties elsewhere that hold a Document.

AdjustLayoutPreference.parentAnchoredObjectDefault.parentAnchoredObjectSetting.parentArticle.parentAssignment.parentBaselineFrameGridOption.parentBook.styleSourceDocumentBookmark.parentButtonPreference.parentCellStyle.parentCellStyleGroup.parentCellStyleMapping.parentChapterNumberPreference.parentCharStyleMapping.parentCharacterStyle.parentCharacterStyleGroup.parentCjkGridPreference.parentColor.parentColorGroup.parentCompositeFont.parentCondition.parentConditionSet.parentConditionalTextPreference.parentCrossReferenceFormat.parentCrossReferenceSource.parentDTD.parentDashedStrokeStyle.parentDataMerge.parentDataMergeImagePlaceholder.parentDataMergeOption.parentDataMergeQrcodePlaceholder.parentDataMergeTextPlaceholder.parentDictionaryPreference.parentDocumentEvent.parentDocumentPreference.parentDottedStrokeStyle.parentEPubExportPreference.parentEPubFixedLayoutExportPreference.parentEndnoteOption.parentEvent.parentEventListener.parentExportForWebPreference.parentFont.parentFootnoteOption.parentFrameFittingOption.parentGradient.parentGridPreference.parentGuidePreference.parentHTMLExportPreference.parentHTMLFXLExportPreference.parentHyperlink.parentHyperlinkExternalPageDestination.parentHyperlinkPageDestination.parentHyperlinkPageItemSource.parentHyperlinkTextDestination.parentHyperlinkTextSource.parentHyperlinkURLDestination.parentHyphenationException.parentImportExportEvent.parentIndexOptions.parentIndex_.parentIndexingSortOption.parentInk.parentKinsokuTable.parentLanguage.parentLayer.parentLayoutGridDataInformation.parentLinkedPageItemOption.parentLinkedStoryOption.parentMarginPreference.parentMasterSpread.parentMetadataPreference.parentMixedInk.parentMixedInkGroup.parentMojikumiTable.parentMojikumiUiPreference.parentMotionPreset.parentMutationEvent.parentNamedGrid.parentNumberingList.parentObjectStyle.parentObjectStyleGroup.parentPDFComment.parentPageItemDefault.parentParaStyleMapping.parentParagraphDestination.parentParagraphStyle.parentParagraphStyleGroup.parentPasteboardPreference.parentPlaceGun.parentPreference.parentPreflightOption.parentPreflightProcess.targetObjectPreflightProfile.parentPrintBookletOption.parentPrintBookletPrintPreference.parentPrintEvent.parentPrintPreference.parentPublishExportPreference.parentSection.parentSpread.parentStory.parentStoryGridDataInformation.parentStoryPreference.parentStripedStrokeStyle.parentStrokeStyle.parentSwatch.parentTOCStyle.parentTableStyle.parentTableStyleGroup.parentTableStyleMapping.parentTaggedPDFPreference.parentTextDefault.parentTextFramePreference.parentTextPreference.parentTextVariable.parentTextWrapPreference.parentTint.parentTransparencyPreference.parentTrapPreset.parentValidationError.parentViewPreference.parentWatermarkPreference.parentXMLComment.parentXMLElement.parentXMLExportMap.parentXMLExportPreference.parentXMLImportMap.parentXMLImportPreference.parentXMLInstruction.parentXMLItem.parentXMLPreference.parentXMLTag.parentXmlStory.parent

Parameter of 44

Method parameters that accept a Document.

Application.exportArticleFolio(portraitDocument)Application.exportDpsArticle(document)Application.exportMiniFolio(portraitDocument)Application.getAllOverlays(portraitDocumentForCheckingOverlays)Asset.placeAsset(on)Bookmark.move(reference)Buttons.add(reference)CellStyle.move(reference)CellStyleGroup.move(reference)CharacterStyle.move(reference)CharacterStyleGroup.move(reference)CheckBoxes.add(reference)ComboBoxes.add(reference)Documents.itemByRange(from)Documents.nextItem(obj)Documents.previousItem(obj)EndnoteTextFrames.add(reference)FormFields.add(reference)GraphicLines.add(reference)Groups.add(reference)HtmlItems.add(reference)ListBoxes.add(reference)MasterSpread.duplicate(reference)Movies.add(reference)MultiStateObjects.add(reference)ObjectStyle.move(reference)ObjectStyleGroup.move(reference)Ovals.add(reference)Pages.add(reference)ParagraphStyle.move(reference)ParagraphStyleGroup.move(reference)Polygons.add(reference)PreflightProcesses.add(targetObject)RadioButtons.add(reference)Rectangles.add(reference)SignatureFields.add(reference)Sounds.add(reference)Spread.duplicate(reference)Spread.move(reference)Spreads.add(reference)TableStyle.move(reference)TableStyleGroup.move(reference)TextBoxes.add(reference)TextFrames.add(reference)

Return 15

Methods that return a Document.

Document.getElements()Document.save()Documents.[]()Documents.add()Documents.anyItem()Documents.everyItem()Documents.firstItem()Documents.item()Documents.itemByID()Documents.itemByName()Documents.itemByRange()Documents.lastItem()Documents.middleItem()Documents.nextItem()Documents.previousItem()