Document Object Model

Name	Description
AdFrame	A frame containing advertorial or editorial content
AdSettings	The general Ad Settings for the Document
AlternateLayout	An alternate layout for the document. This can contain different document dimensions, but also different positioning of frames. Certain elements (layers, pages, frames) can also be made dependant on the currently selected layout (and made invisible based on those conditions)
AlternateLayoutProperties	An internal holder for properties which are dependant on the selected alternate layout (such as the document dimensions, frame positions, etc.)
AlternateLayoutProperty	An internal holder for a property which is dependant on the selected alternate layout (such as the document dimensions, frame positions, etc.)
AlternateLayouts	The list of available alternate layouts in the document
AlternateLayoutSelection	Properties for the visibility of an object depending on the selected AlternateLayout
Annotation	An annotation / Comment on one of the pages
Annotations	The document's annotations / comments
BarcodeFrame	A frame containing a barcode. This type of frame cannot be resized, as the dimensions are imported from the generated barcode. The type of barcode (and most of its settings) are maintained in the BackOffice, in the "BarcodeTypes" resource. The combination of a barcode type and the actual barcode text result in the visualization of the barcode in the document and its output.
BaseLineGridOptions	Settings for a baseline grid (either on the entire document, or on an individual frame)
BookMark	A bookmark in the document. Bookmarks can be used to navigate in the document (both in edit and book mode), but they can also be exported to PDF
BookMarks	The list of the document's BookMarks
CharacterStyle	A CharacterStyle contains a series of character settings which can be managed separately from the text in a document. CharacterStyles can be assigned to text, and changes to the style will reflect to all of the texts which have the CharacterStyle assigned
CharacterStyles	The list of CharacterStyles in the document
CircleFrame	A frame containing only a circular border and fill
Color	One of the document's colors Unlike other lists, not every color is editable in the List panel. This depends on the isDocumentColor property, which is false for "custom" colors (defined for a single object)
Colors	The document's color list. Colors where isDocumentColor = true are editable in the Color list in the interface. Other colors are custom for individual objects
CommonStrings	A placeholder object for common strings used in CHILI editor. These can be translated via the Languages Resource in the BackOffice. The object has no other purpose or functionalities.
CustomButton	A custom button is represented by a button (or clickable icon) in the editor interface which executes a custom action
CustomButtonClickAction	The Document Action assigned to a Custom Button
CustomButtons	A list of Custom Buttons
DataSource	Settings for a DataSource inside the document
Document	The main Document object
DocumentAction	The DocumentAction class is inherited from the various locations where an action can be executed (eg: VariableValueAction, CustomButtonClickAction, ...). It allows a simple type of scripting on the document
DocumentBase	The basic object from which all Document classes inherit
DocumentConstraints	Constraints which apply to the document itself, rather than on its content. For constraints on content, Additional objects (eg FrameConstraints) are available
DocumentEventAction	A Document Action triggered by certain events inside the Document
DocumentEventActionAction	Action triggered when the variable's value is changed
DocumentEventActions	Document Actions triggered by Document Events
DocumentListBase	List objects in the Document (e.g.: Colors, Pages, ...)
DocumentListFromServerBase
DocumentListItemBase	A list item (Color, Page, ...)
DocumentListItemSelectableBase
Font	A font available for text editing in the document. The font is downloaded by the editor in a closed swf format, so it cannot be used by the user outside of the Editor environment. Compilation is done automatically by the CHILI server. Available fonts are managed in the 'Fonts' Resource through the BackOffice. CHILI Publisher supports otf and ttf fonts (both being supported on Windows, where the CHILI server creates PDF files)
Fonts	The list of fonts available to the server for editing
Frame	The basis implementation of a frame. Any Frame placed in a document will be of a type inheriting from the 'Frame' class (eg: RectangleFrame, TextFrame, BarcodeFrame, ...)
FrameAnchor	A frame anchor allows a frame to be moved (or resized) with another object (depending on the targetType property) If to opposing frame anchors (eg 'left' and 'right') are defined, the frame will be resized/stretched. If only one is defined (eg 'left'), the frame will be moved
FrameAnchors	The list of frame anchors for a particular frame.
FrameConstraints	Settings to determine the allowed actions on the frames of the parent object (document, page, layer, frame)
FrameContentConstraints	Content Constraints applied to a selection of frames
FrameHandlePreferences	Preferences for the display of Frame Handles inside CHILI Editor
Frames	The list of frames of a page
GeneralAnnotationSettings	General settings (for the entire document) to influence behaviour and look and feel of annotations in the document
GeneralLinkSettings	General settings (for the entire document) to influence behaviour and look and feel of links in the document
ImageFrame	A frame containing an asset (jpg, tif, pdf, ...)
ImageFrameBox	The relative position of a box within an image (mostly used for PDF crop/trim/... boxes)
ImageFrameBoxes	The list of boxes available for a placed asset
ImageFrameMetaDataValue	A metadata name/value pair for a placed asset
ImageFrameMetaDataValues	The list of metadata values available for a placed asset
ImportWarning	A warning generated by importing applications (such as the InDesign Extension)
ImportWarnings	A list of the warnings generated during import of the CHILI document (if any), and associated information about the import
InlineFrame	A frame placed inside a running text
InlineFrames	The list of frames in a TextFrame
Layer	A document Layer
Layers	The document's Layers
LineFrame	A frame containing a single line
LinkSettings	Link Settings as applied to frames or bookmarks
Page	A page in the document
Pages	The document's page list
ParagraphStyle	A ParagraphStyle contains a series of character settings which can be managed separately from the text in a document. ParagraphStyle can be assigned to text, and changes to the style will reflect to all of the texts which have the ParagraphStyle assigned
ParagraphStyleBackgroundOptions	The settings for a Paragraph Style's background color
ParagraphStyleDiagonalRuleOptions	The settings for a diagonal line drawn on top of the paragraphs with the current style
ParagraphStyleListSettings	Settings for bullets in a paragraph style
ParagraphStyleRuleOptions	Rule options for lines drawn above or below all lines in the associated paragraphs
ParagraphStyles	The list of available paragraph styles in the document
Path	A representation of a path, containing multiple points (line or bezier)
PathPoint	A single path point (which can contain a bezier curve)
PathPoints	A list of path points
Paths	A list of paths
PreflightPreferences	The document's preflight preferences determine the real-time preflighting performed on the document as the user is working in it. Certain actions (such as saving or PDF generation) can be prevented when errors are found, or may require the user to sign of on warnings.
PreflightResult	A preflight result encountered as the user is working on the document
PreflightResults	The list of preflight results found in the document
Range	A range
RectangleFrame	A frame containing a rectangular border and fill, without additional content
SearchResult	A result of a search action
SearchResults	A list of search results
SectionOptions	Section Options for a Page
ShapeFrame	A frame containing a complex shape (with multiple points or bezier curves)
SnippetFrame	A frame containing another CHILI document / snippet.
SpellCheckPreferences	Preferences for the behavior of Spell Checking
StoryViewPreferences	Preferences for the display of texts in the Story Editor
TableBorderAndFill	Border And Fill settings for an object inside a Table
TableCell	A cell in a table
TableCells	A list of table cells
TableColumn	A column in a table
TableColumns	A list of table rows
TableFrame	A table frame
TableRow	A row in a table
TableRows	A list of table rows
TextFormat	Various settings applicable to selected text or text styles
TextFrame	A frame containing text. Text can be editable within the editor by the end user, or can be 'variable' (in which case content can only be edited by the administrators directly, or by using variables in the case of an end user). If the frame is part of a chain, many settings (mostly those applying to the text rather than the container) are inherited from the first frame in the chain.
TextFrameLink	An automatically extracted text link (based on www, http, mailto, ... patterns)
TextFrameLinks	A list of links found in a text
TextSelection	The current text selection in the Document
TextUnderLineOptions	Options for Text Underline settings
Variable	A variable field. Many properties only apply to certain dataTypes
VariableChangeAction	Action triggered when the variable's value is changed
VariableListItem	A list item for a variable of dataType 'list'
VariableListItems	The list items for a variable of dataType 'list'
Variables	The list of variables available in the document
VariableTableColumn	A variable table column
VariableTableColumns	A list of variable table columns
VariableTableColumnSetting	The settings for a column in a variable of dataType 'table'
VariableTableColumnSettings	The list of available columns in a variable of dataType 'table'
VariableTableRow	A row in a variable
VariableTableRows	A list of variable table rows
VariableTableRowSetting	The settings of a row in a variable of dataType 'table'
VariableTableRowSettings	The list of rows in a variable of dataType 'table'
VariableTableSettings	The table settings for a variable of dataType 'table'
VariableValidationAction	Action executed when a variable needs to be validated in the input form
VariableValueAction	Action executed to calculate the value of a variable of dataType 'calculated_field'
VariableVisibleAction	Action executed to determine whether or not the variable can be shown in the input form
ViewPreferences	The document's ViewPreferences, which determine the way the user interacts with the editing portion of the document

GraFx Publisher Documentation

Document Object Model

Analytics

Related content