Document

A document.

Document Properties

Property Type Access Description
AccurateLABSpots Boolean r/w If true, use LAB alternates for spot colors when available.
AfterBlendingIntent idRenderingIntent enumeration r/w The intent after blending.
AllGraphics Array of Graphics read All graphics contained by the object.
AllPageItems Array of PageItems read All page items contained by the object.
AnchoredObjectDefaults AnchoredObjectDefault read Anchored object defaults.
AnchoredObjectSettings AnchoredObjectSetting read Anchored object settings for the object.
Assignments Assignments read Every assignment.
AssociatedXMLElement XMLItem read The XML element associated with the object.
BaselineFrameGridOptions BaselineFrameGridOption read Baseline frame grid options.
Bookmarks Bookmarks read Every bookmark.
ButtonPreferences ButtonPreference read Button preferences.
Buttons Buttons read The buttons contained by the object.
CharacterStyles CharacterStyles read Character Styles.
CMYKPolicy idColorSettingsPolicy enumeration r/w The policy to apply to new CMYK content.
CMYKProfile String r/w The current CMYK profile.
CMYKProfileList Array of Strings read A list of the names of available CMYK profiles.
Colors Colors read All colors.
DashedStrokeStyles DashedStrokeStyles read Every dashed stroke style.
DataMergeImagePlaceholders DataMergeImagePlaceholders read Every Data Merge Image Placeholder.
DataMergeOptions DataMergeOption read Data Merge Options.
DataMergeProperties DataMerge read Data merge properties.
DataMergeTextPlaceholders DataMergeTextPlaceholders read Every Data Merge Text Placeholder.
DefaultImageIntent idRenderingIntent enumeration r/w The intent for images.
DictionaryPreferences DictionaryPreference read User dictionary preferences.
DocumentPreferences DocumentPreference read Document preferences.
DottedStrokeStyles DottedStrokeStyles read Every dotted stroke style.
DTDs DTDs read All DTDs.
EditingState idEditingState enumeration read Editing state for Version Cue.
FilePath File (String) read The file path.
Fonts Fonts read Every font.
FootnoteOptions FootnoteOption read Footnote options.
FormFields FormFields read The form fields contained by the object.
FullName File (String) read The full path including the name.
GalleyPreferences GalleyPreference read Galley preferences.
Gradients Gradients read All gradients.
GraphicLines GraphicLines read The graphic lines contained by the object.
GridPreferences GridPreference read Grid preferences.
Groups Groups read The groups contained by the object.
GuidePreferences GuidePreference read Guide preferences.
Guides Guides read Every guide.
HyperlinkExternalPageDestinations HyperlinkExternalPageDestinations read Every hyperlink external page destination.
HyperlinkPageDestinations HyperlinkPageDestinations read Every hyperlink page destination.
HyperlinkPageItemSources HyperlinkPageItemSources read Every hyperlink page item source.
Hyperlinks Hyperlinks read Every hyperlink.
HyperlinkTextDestinations HyperlinkTextDestinations read Every hyperlink text destination.
HyperlinkTextSources HyperlinkTextSources read Every hyperlink text source.
HyperlinkURLDestinations HyperlinkURLDestinations read Every hyperlink URL destination.
HyphenationExceptions read Every hyphenation exception.
Index Long read Index of the object within its parent object.
Indexes Indexes read Every index.
IndexGenerationOptions IndexOptions read The options controlling index generation.
Inks Inks read Every InDesign ink.
Label String r/w A label that can be set to any string.
Languages Languages read Every language.
Layers Layers read Every layer.
LayoutAdjustmentPreferences LayoutAdjustmentPreference read Layout Adjustment preferences.
LayoutWindows LayoutWindows read Every layout window.
Links Links read Every file link.
MarginPreferences MarginPreference read Margin preferences.
MasterSpreads MasterSpreads read All master spreads.
MetadataPreferences MetadataPreference read Metadata preferences.
MixedInkGroups MixedInkGroups read All mixed ink groups.
MixedInks MixedInks read All mixed inks.
Modified Boolean read If true, the document has been modified since it was last saved.
Name String read The name of the object.
ObjectStyles ObjectStyles read Object Styles.
Ovals Ovals read All ovals contained by the object.
PackageForGoLivePreferences PackageForGoLivePreference read The default Package For GoLive preferences.
PageItems PageItems read The page items contained by the object.
Pages Pages read Every page.
ParagraphStyles ParagraphStyles read Paragraph Styles.
Parent Object read The parent of the object.
PasteboardPreferences PasteboardPreference read Pasteboard preferences.
Polygons Polygons read The polygons contained by the object.
PrintPreferences PrintPreference read Print preferences.
Rectangles Rectangles read The rectangles contained by the object.
RedoHistory Array of Strings read A list of events in the redo queue.
RedoName String read Name of the action on the top of the redo stack.
RGBPolicy idColorSettingsPolicy enumeration r/w The policy to apply to new RGB content.
RGBProfile String r/w The current RGB profile.
RGBProfileList Array of Strings read A list of the names of available RGB profiles.
Saved Boolean read If true, the document has been saved since it was created.
Sections Sections read All layout sections.
Selection Object, Array of Objects, idNothingEnum enumeration r/w The selection of the front-most window.
SolidColorIntent idRenderingIntent enumeration r/w The intent for solid colors.
Spreads Spreads read Every spread.
Stories Stories read Stories.
StoryPreferences StoryPreference read Story preferences.
StoryWindows StoryWindows read Every story window.
StripedStrokeStyles StripedStrokeStyles read Every stripe stroke style.
StrokeStyles StrokeStyles read Every stroke style.
Swatches Swatches read All swatches.
TextDefaults TextDefault read Text defaults.
TextFramePreferences TextFramePreference read Text frame preferences.
TextFrames TextFrames read The text frames contained by the object.
TextPreferences TextPreference read Text preferences.
Tints Tints read All tints.
TOCStyles TOCStyles read Every TOC style.
TransparencyPreferences TransparencyPreference read Transparency preferences.
TrapPresets TrapPresets read Every InDesign trap preset.
UndoHistory Array of Strings read A list of the events in the undo queue.
UndoName String read Name of the action on the top of the undo stack.
UnusedSwatches Array of Swatches read Any swatches that aren’t being used.
ValidationErrors ValidationErrors read All XML validation errors.
VersionState idVersionState enumeration read Version state for Version Cue.
ViewPreferences ViewPreference read View preferences.
Visible Boolean read If true, the document is visible.
Windows Windows read Every window.
XMLComments XMLComments read All XML comments.
XMLElements XMLElements read All XML elements.
XMLExportMaps XMLExportMaps read Every style to XML tag mapping.
XMLExportPreferences XMLExportPreference read The default XML export preferences.
XMLImportMaps XMLImportMaps read Every XML tag to style mapping.
XMLImportPreferences XMLImportPreference read The default XML import preferences.
XMLInstructions XMLInstructions read All XML instructions.
XMLItems XMLItems read All XML items.
XMLPreferences XMLPreference read The default XML preferences.
XMLTags XMLTags read All XML tags.
XMLViewPreferences XMLViewPreference read The default XML view preferences.
ZeroPoint Array of 2 Units (Doubles or Strings) r/w The document’s ruler origin.

Document Methods

Method Returns Description
AutoStyle Nothing Auto style the document based on the tag to style map.
AutoTag Nothing Auto tag the document based on the style to tag map.
Close Nothing Closes the document.
CreateTOC Array of Stories Create a table of contents for a document or book.
DeleteUnusedTags Nothing Delete unused XML markup tags.
Export Nothing Exports the object to a file.
ExtractLabel String Gets the content of the label associated with the specified key (name).
ImportAdobeSwatchbookProcessColor Color Import a process color from a preloaded Adobe color book.
ImportAdobeSwatchbookSpotColor Color Import a spot color from a preloaded Adobe color book.
ImportDtd Nothing Import a DTD to use for validation.
ImportStyles Nothing Import styles or presets.
ImportXML Nothing Import a XML file into an InDesign document.
InsertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
LoadSwatches Nothing Load swatches from a file.
LoadXMLTags Nothing Load a set of tags from an external file.
Package Boolean Packages the document.
PackageForGoLive Boolean Packages for GoLive.
Place Nothing Places a file.
PrintOut Nothing Prints the document.
Recompose Nothing Recomposes the text in the object.
Redo Nothing Redo the last action.
RevertToProject Nothing Revert to the version of the document in Version Cue.
Save Document Save the document.
SaveAVersion Nothing Save a version to Version Cue.
SaveSwatches Nothing Save given swatches to a swatchbook file.
SaveXMLTags Nothing Save a set of tags to an external file.
Search Array of Texts Searches for text and returns a list of text objects matching the search string and/or formatting specified by the find preferences. Search can also replace the text and/or formatting. This command corresponds to InDesign’s Find/Change feature.
Select Nothing Selects the object.
SynchronizeWithVersionCue idVersionCueSyncStatus enumerator Synchronize with Version Cue.
Undo Nothing Undo the last action.

Leave a Comment

Previous post:

Next post: