Information Classification: External Restricted.
See https://www.chili-publish.com/security
Document Object Model - Document
The main Document object
Fields
Name |
Type |
Triggers |
Description |
---|---|---|---|
pages |
|
Document's pages list |
|
paragraphStyles |
|
Document's ParagraphStyles list |
|
characterStyles |
|
Document's CharacterStyles list |
|
colors |
|
Document's Color List (including "custom" colors, which are not displayed in the ColorList input panel) |
|
layers |
|
Document's Layers list |
|
variables |
|
Document Variable Definitions and values |
|
fonts |
|
Document's Fonts list |
|
alternateLayouts |
|
Document's Alternate Layout list |
|
preflightPreferences |
|
Document's Preflight Preferences |
|
preflightResults |
|
Document's Preflight Result list |
|
bookMarks |
|
Document's BookMarks list |
|
adSettings |
|
Document's AdSettings |
|
frameConstraints |
|
Applied Frame constraints on document level (all sub-levels inherit from this) |
|
id |
string |
|
Document ID |
name |
string |
|
Document name |
path |
string |
|
Document relative path |
zoom |
number |
|
Current document zoom (percentage) |
width |
unit |
Document Width |
|
height |
unit |
Document height |
|
documentAssetDir |
string |
Document's asset directory |
|
userAssetDir |
string |
User asset directory |
|
userGroupAssetDir |
string |
User group asset directory |
|
facingPages |
bool |
Document contains facing pages (spreads) |
|
bleedLeft |
unit |
Left bleed |
|
bleedTop |
unit |
Top bleed |
|
bleedRight |
unit |
Right bleed |
|
bleedBottom |
unit |
Bottom bleed |
|
slugLeft |
unit |
Slug left |
|
slugRight |
unit |
Slug right |
|
slugTop |
unit |
Slug top |
|
slugBottom |
unit |
Slug bottom |
|
flapWidth |
unit |
Width of flaps, for book cover guides |
|
flapWrap |
unit |
Wrap of flaps, for book cover guides |
|
spineWidth |
unit |
Spine width for cover guides |
|
spineHinge |
unit |
Spine hinge for covor guides |
|
constraints |
|
Document Constraints |
|
viewPreferences |
|
Document's ViewPreferences |
|
horizontalSpine |
bool |
Draw spine guide as horizontal rule, rather than default vertical |
|
allowWorkSpaceChanges |
bool |
Allow workspace administration, based on user privileges, or view simulation |
|
commonStrings |
|
Placeholder object for common localized strings |
|
importWarnings |
|
Document's ImportWarnings list |
|
initialLayout |
|
Document's initially loaded Alternate Layout |
|
savedInEditor |
bool |
|
If true, the document has been saved at least once in CHILI editor (rather than having been created using an external application such as the InDesign Extension). External applications which edit the document's XML should set this value to 'false' for best results. |
dataSource |
|
Document's DataSource Settings |
|
frameContentConstraints |
|
Frame content constraints on document level (all sub-levels inherit from this) |
|
baseLineGridOptions |
|
Document BaseLineGrid Options |
|
allowContentAdministration |
bool |
Allow content administration, based on user privileges, or view simulation |
|
simulateUser |
string |
Simulate user view for the current editor session |
|
textLanguage |
string |
|
Default text language (ID or XX System name of language) |
chiliVersion |
|
The version in which the document was last saved |
|
eventActions |
|
Document's EventActions list |
|
foldSettingID |
Document's default Folding Settings ID |
||
foldDocIdentifier |
|
||
threeDModelID |
Document's default Folding Settings ID |
||
threeDModelDocIdentifier |
|
||
maxCliTimeout |
|
Used for timing if CLI is not responding. And to test if document loading in CLI is taking too long. |
|
saveInactiveTextPositions |
|
Variable used to skip saving unused alternate layouts / pages / frames |
|
copyFittingStyles |
|
Document's Copy Fitting Style list |
Functions
Called from JavaScript using editor.ExecuteFunction("object_descriptor", "FUNCTION_NAME", args...)
Name |
Arguments |
Returns |
Description |
---|---|---|---|
Save |
|
|
Saves the document (asynchronously). When finished, the DocumentSaved event is triggered |
Revert |
|
|
Reverts the document to its last Saved state |
PlaceContent |
|
Ads pages and frames based on XML descriptions (see External XML in the API Guide) |
|
SetCursor |
|
Sets the current cursor |
|
OpenDocument |
|
Opens the new document in the existing Editor instance (without needing to relead the Editor swf) |
|
CreateTempPDF_FromXml |
[pdfSettingsXmlString (string) |
|
Initiates PDF creation within the editor, based on the temporary (unsaved) status of the current document |
CreateTempImages_FromXml |
[pdfSettingsXmlString (string) |
|
Initiates PDF creation within the editor, based on the temporary (unsaved) status of the current document |
Inherits from
All information on this page must be treated as External Restricted, or more strict. https://www.chili-publish.com/security