document

A collection of documents.

Element

assignment
bookmark
button
cell style
cell style group
character style
character style group
color
dashed stroke style
data merge image placeholder
data merge text placeholder
dotted stroke style
DTD
event
event listener
font
form field
gradient
graphic line
group
guide
hyperlink
hyperlink external page destination
hyperlink page destination
hyperlink page item source
hyperlink text destination
hyperlink text source
hyperlink URL destination
hyphenation exception
index
indexing sort option
ink
language
layer
layout window
link
master spread
mixed ink
mixed ink group
numbering list
object style
object style group
oval
page
page item
paragraph style
paragraph style group
polygon
rectangle
section
spread
story
story window
striped stroke style
stroke style
swatch
table style
table style group
text frame
text variable
tint
TOC style
trap preset
validation error
window
XML comment
XML element
XML export map
XML import map
XML instruction
XML item
xml story
XML tag

document Properties

Property Type Access Description
accurate LAB spots boolean r/w If true, uses LAB alternates for spot colors when available.
active layer layer r/w The active layer. Can also accept: string.
after blending intent use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric,
use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric,
use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric, 		r/w The rendering intent for colors that result from transparency interactions on the page after blending.
all cell styles List of cell style read All Cell styles
all character styles List of character style read Lists all character styles (regardless of their group).
all graphics List of graphic read Lists all graphics contained by the document.
all object styles List of object style read All object styles contained by the document.
all page items List of page item read Lists all page items contained by the document.
all paragraph styles List of paragraph style read Lists all paragraph styles (regardless of their group).
all table styles List of table style read All Table styles
anchored object defaults anchored object default read Anchored object default settings.
anchored object settings anchored object setting read Anchored object settings.
associated XML element XML item read The XML element associated with the document.
baseline frame grid options baseline frame grid option read Baseline frame grid option settings.
button preferences button preference read Button preference settings.
chapter number preferences chapter number preference read Chapter numbering preferences.
class type class read The class descriptor type.
CMYK policy color policy off,
preserve embedded profiles,
convert to working space,
combination of preserve and safe cmyk,
color policy off,
preserve embedded profiles,
convert to working space,
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.
CMYK profile string r/w The current CMYK profile.
CMYK profile list List of string read A list of valid CMYK profiles.
converted boolean read If true, the document was converted.
data merge options data merge option read The data merge option properties that define the data merge.
data merge properties data merge read Data merge properties that define data merge fields and preferences.
default image intent use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric,
use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric,
use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric, 		r/w The rendering intent for bitmap images.
dictionary preferences dictionary preference read User dictionary preference settings.
document preferences document preference read Document preference settings.
editing state editing unknown,
editing nowhere,
editing remotely,
editing locally,
editing locally locked,
editing conflict,
editing unknown,
editing nowhere,
editing remotely,
editing locally,
editing locally locked,
editing conflict, 		read The Version Cue editing state of the file.
export for web preferences export for web preference read The default export for web preferences.
file path alias or string read The full path to the file.
footnote options footnote option read Footnote option settings.
frame fitting options frame fitting option read 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.
full name alias or string read The full path to the document, including the name of the document.
galley preferences galley preference read Galley preference settings.
grid preferences grid preference read Grid preference settings.
guide preferences guide preference read Guide preference settings.
index integer read The index of the document within its containing object.
index generation options index options read The index options properties that define how an index is formatted.
label string r/w A property that can be set to any string.
layout adjustment preferences layout adjustment preference read Layout sdjustment preference settings.
margin preferences margin preference read Margin preference settings.
metadata preferences metadata preference read Metadata preference settings.
modified boolean read If true, the document has been modified since it was last saved.
name string read The name of the document.
object reference document read An object reference for the document.
page item defaults page item default read The default page item formatting for the document.
parent reference read The parent of the document (a application).
pasteboard preferences pasteboard preference read Pasteboard preference settings.
print booklet options print booklet option read Booklet printing options.
print booklet print preferences print booklet print preference read Print booklet preferences.
print preferences print preference read Print preference settings.
properties record r/w A property that allows setting of several properties at the same time.
read only boolean read If true, the document is read-only.
recovered boolean read If true, the document was recovered.
redo history List of string read The names of the items in the redo stack.
redo name string read The name of the action on the top of the redo stack.
RGB policy color policy off,
preserve embedded profiles,
convert to working space,
combination of preserve and safe cmyk,
color policy off,
preserve embedded profiles,
convert to working space,
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.
RGB profile string r/w The current RGB profile.
RGB profile list List of string read A list of valid RGB profiles.
saved boolean read If true, the document has not been saved since it was created.
selection List of reference r/w The selected object(s). Can also accept: object or nothing.
solid color intent use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric,
use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric,
use color settings,
perceptual,
saturation,
relative colorimetric,
absolute colorimetric, 		r/w The rendering intent for all vector art (areas of solid color) in native objects.
story preferences story preference read Story preference settings.
text defaults text default read Text default settings.
text frame preferences text frame preference read Text frame preference settings.
text preferences text preference read Text preference settings.
transparency preferences transparency preference read Transparency preference settings.
undo history List of string read The names of the items in the undo stack.
undo name string read The name of the action on the top of the undo stack.
unused swatches List of swatch read The swatches that are not being used.
version state version unknown,
project file newer,
local project match,
local newer,
version conflict,
no resource,
version unknown,
project file newer,
local project match,
local newer,
version conflict,
no resource, 		read The Version Cue version state of the file.
view preferences view preference read View preference settings.
visible boolean read If true, the document is visible.
XML export preferences XML export preference read XML export preference settings.
XML import preferences XML import preference read XML import preference settings.
XML preferences XML preference read The XML preference settings.
XML view preferences XML view preference read XML view preference settings.
zero point List of number or string r/w The ruler origin, specified as page coordinates in the format [x, y].

Leave a Comment

Previous post:

Next post: