A document.
document elements
| Name | Refer to By |
|---|---|
| assignments | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| bookmarks | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| buttons | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| character styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| colors | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| dashed stroke styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| data merge image placeholders | by numeric index, as a range of elements, before/after another element, satisfying a test |
| data merge text placeholders | by numeric index, as a range of elements, before/after another element, satisfying a test |
| dotted stroke styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| d t ds | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| fonts | by numeric index, as a range of elements, before/after another element, satisfying a test |
| form fields | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| gradients | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| graphic lines | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| groups | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| guides | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlink external page destinations | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlink page destinations | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlink page item sources | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlinks | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlink text destinations | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlink text sources | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyperlink u r l destinations | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| hyphenation exceptions | by numeric index, as a range of elements, before/after another element, satisfying a test |
| indexes | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| inks | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| languages | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| layers | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| layout windows | by numeric index, as a range of elements, before/after another element, satisfying a test |
| links | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| master spreads | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| mixed ink groups | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| mixed inks | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| object styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| ovals | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| page items | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| pages | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| paragraph styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| polygons | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| rectangles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| sections | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| spreads | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| stories | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| story windows | by numeric index, as a range of elements, before/after another element, satisfying a test |
| striped stroke styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| stroke styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| swatches | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| text frames | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| tints | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| t o c styles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| trap presets | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| validation errors | by numeric index, as a range of elements, before/after another element, satisfying a test |
| windows | by numeric index, as a range of elements, before/after another element, satisfying a test |
| x m l comments | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| x m l elements | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| x m l export maps | by numeric index, as a range of elements, before/after another element, satisfying a test |
| x m l import maps | by numeric index, as a range of elements, before/after another element, satisfying a test |
| x m l instructions | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| x m l items | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| x m l tags | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
document properties
| Property | Type | Access | Description |
|---|---|---|---|
| accurate LAB spots | boolean | r/w | If true, use LAB alternates for spot colors when available. |
| after blending intent | rendering intent enumeration | r/w | The intent after blending. |
| all graphics | list of graphics | read | All graphics contained by the object. |
| all page items | list of page items | read | All page items contained by the object. |
| anchored object defaults | anchored object default | read | Anchored object defaults. |
| anchored object settings | anchored object setting | read | Anchored object settings for the object. |
| associated XML element | XML item | read | The XML element associated with the object. |
| baseline frame grid options | baseline frame grid option | read | Baseline frame grid options. |
| button preferences | button preference | read | Button preferences. |
| class | integer | read | The class descriptor type. |
| CMYK policy | color settings policy enumeration | r/w | The policy to apply to new CMYK content. |
| CMYK profile | string | r/w | The current CMYK profile. |
| CMYK profile list | list of strings | read | A list of the names of available CMYK profiles. |
| data merge options | data merge option | read | Data Merge Options. |
| data merge properties | data merge | read | Data merge properties. |
| default image intent | rendering intent enumeration | r/w | The intent for images. |
| dictionary preferences | dictionary preference | read | User dictionary preferences. |
| document preferences | document preference | read | Document preferences. |
| editing state | editing state enumeration | read | Editing state for Version Cue. |
| enable undo | boolean | r/w | Whether undo is enabled. |
| file path | alias or string | read | The file path. |
| footnote options | footnote option | read | Footnote options. |
| full name | alias or string | read | The full path including the name. |
| galley preferences | galley preference | read | Galley preferences. |
| grid preferences | grid preference | read | Grid preferences. |
| guide preferences | guide preference | read | Guide preferences. |
| index | integer | read | Index of the object within its parent object. |
| index generation options | index options | read | The options controlling index generation. |
| label | string | r/w | A label that can be set to any string. |
| layout adjustment preferences | layout adjustment preference | read | Layout Adjustment preferences. |
| margin preferences | margin preference | read | Margin preferences. |
| metadata preferences | metadata preference | read | Metadata preferences. |
| modified | boolean | read | If true, the document has been modified since it was last saved. |
| name | string | read | The name of the object. |
| object reference | object | read | An object reference for this object. |
| package for GoLive preferences | package for GoLive preference | read | The default Package For GoLive preferences. |
| parent | object | read | The parent of the object. |
| pasteboard preferences | pasteboard preference | read | Pasteboard preferences. |
| print preferences | print preference | read | Print preferences. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| redo history | list of strings | read | A list of events in the redo queue. |
| redo name | string | read | Name of the action on the top of the redo stack. |
| RGB policy | color settings policy enumeration | r/w | The policy to apply to new RGB content. |
| RGB profile | string | r/w | The current RGB profile. |
| RGB profile list | list 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. |
| selection | object, list of objects, nothing enum enumeration | r/w | The selection of the front-most window. |
| solid color intent | rendering intent enumeration | r/w | The intent for solid colors. |
| story preferences | story preference | read | Story preferences. |
| text defaults | text default | read | Text defaults. |
| text frame preferences | text frame preference | read | Text frame preferences. |
| text preferences | text preference | read | Text preferences. |
| transparency preferences | transparency preference | read | Transparency preferences. |
| undo history | list of strings | read | A list of the events in the undo queue. |
| undo name | string | read | Name of the action on the top of the undo stack. |
| unused swatches | list of swatches | read | Any swatches that aren’t being used. |
| version state | version state enumeration | read | Version state for Version Cue. |
| view preferences | view preference | read | View preferences. |
| visible | boolean | read | If true, the document is visible. |
| XML export preferences | XML export preference | read | The default XML export preferences. |
| XML import preferences | XML import preference | read | The default XML import preferences. |
| XML preferences | XML preference | read | The default XML preferences. |
| XML view preferences | XML view preference | read | The default XML view preferences. |
| zero point | list of 2 numbers or strings | r/w | The document’s ruler origin. |
document methods
| Method | Returns | Description |
|---|---|---|
| auto style | Nothing | Auto style the document based on the tag to style map. |
| auto tag | Nothing | Auto tag the document based on the style to tag map. |
| close | Nothing | Closes the document. |
| create TOC | list of stories | Create a table of contents for a document or book. |
| delete unused tags | Nothing | Delete unused XML markup tags. |
| export | Nothing | Export the object to file. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| import Adobe swatchbook process color | color | Import a process color from a preloaded Adobe color book. |
| import Adobe swatchbook spot color | color | Import a spot color from a preloaded Adobe color book. |
| import dtd | Nothing | Import a DTD to use for validation. |
| import styles | Nothing | Import styles or presets. |
| import XML | Nothing | Import a XML file into an InDesign document. |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| load swatches | Nothing | Load swatches from a file. |
| load XML tags | Nothing | Load a set of tags from an external file. |
| package | boolean | Packages the document. |
| package for GoLive | boolean | Packages for GoLive. |
| place | Nothing | Places a file. |
| Nothing | Print the object. | |
| recompose | Nothing | Recomposes the text in the object. |
| redo | Nothing | Redo the last action. |
| revert to project | Nothing | Revert to the version of the document in Version Cue. |
| save | document | Save the document. |
| save a version | Nothing | Save a version to Version Cue. |
| save swatches | Nothing | Save given swatches to a swatchbook file. |
| save XML tags | Nothing | Save a set of tags to an external file. |
| search | list 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. |
| synchronize with version cue | file downloaded/file uploaded/file unlocked/file skipped/file no change | Synchronize with Version Cue. |
| track plugins | string | Streams the document detecting all references to data added by the specified plug-ins. |
| undo | Nothing | Undo the last action. |