Editor Events

AlternateLayoutAdded

Triggered when the selected alternate layout for the document is changed

AlternateLayoutDefinitionChanged

Triggered when the definition of an alternate layout is changed

AlternateLayoutDeleted

Triggered when an alternate layout is deleted from the document

AlternateLayoutIndexChanged

Triggered when the index of an alternate layout is changed. The index is calculated based on the layout name (and used by the editor to recalculate the positions of the list items)

AlternateLayoutNameChanged

Triggered when the name of an alternate layout is changed

AlternateLayoutSelectionChanged

Triggered when the configuration for visibility in an alternate layout changes for an object. This can be applied to Frames, Layers, Pages, ...

AnnotationAdded

Triggered when a new annotation is added to a page

AnnotationDefinitionChanged

Triggered when the definition of an annotation is changed

AnnotationDeleted

Triggered when an annotation is removed from a page

AnnotationMoved

Triggered when an annotation is moved or resized

AutoTextCursorChanged

Triggered when the autoTextCursor property of the viewpreferences is changed

BarcodeFrameVariableChanged

Triggered when the variable associated to a Barcode Frame is modified

BaseLineGridOptionsChanged

Triggered when the settings of a baseline grid are modified

BaseLineGridVisibilityChanged

Triggered when the visibility of baseline grids are changed in the ViewPreferences

BleedVisibilityChanged

Triggered when the visibility of bleed is changed in the ViewPreferences

BorderVisibilityChanged

Triggered when the border visibility for frames is changed in the ViewPreferences

ChainVisibilityChanged

Triggered when the visibility of text chains / stories is changed in the ViewPreferences

CharacterStyleAdded

Triggered when a new CharacterStyle is added to the document

CharacterStyleColorChanged

Triggered when the text color of a Character Style is changed. This can mean that a new color has been selected, or that the value of the previously selected color has been changed

CharacterStyleDefinitionChanged

Triggered when the definition of a CharacterStyle is changed

CharacterStyleDeleted

Triggered when a CharacterStyle is deleted from the document

CharacterStyleIndexChanged

Triggered when the index of a CharacterStyle is changed (based on its name)

CharacterStyleNameChanged

Triggered when the name of a CharacterStyle is changed

CharacterStyleUnderLineChanged

Triggered when character style's underline options are modified

ColorAdded

Triggered when a new color is added to the document

ColorDefinitionChanged

Triggered when the definition of a color is changed

ColorDeleted

Triggered when a color is deleted from the document

ColorIndexChanged

Triggered when the index of a color is changed (based on its name)

ColorNameChanged

Triggered when the name of a color changes

CopyFittingStyleAdded

Triggered when a CopyFittingStyle is added to the document

CopyFittingStyleChanged

Triggered when a CopyFittingStyle is changed/updated

CopyFittingStyleDeleted

Triggered when a CopyFittingStyle is removed from the document

CopyFittingStyleNameChanged

Triggered when the name of a CopyFittingStyle is changed

CopyFrameChanged

Triggered when the current 'copy frame' changes. This frame can then be pasted on the same or a different page

CursorChanged

Triggered when the active cursor changes

CustomButtonAdded

Triggered when a Custom Button is added to an appropriate collection

CustomButtonDefinitionChanged

Triggered when the definition of a Custom Button is changed

CustomButtonDeleted

Triggered when a Custom Button is deleted

CustomButtonIndexChanged

Triggered when the index of a Custom Button is changed

DataSourceChanged

Triggered when the selected DataSource for the document is changed

DataSourceRecordChanged

Triggered when the selected record of the DataSource is changed

DisplayQualityChanged

Triggered when the document's Display Quality for images is changed in the ViewPreferences

DocumentActionChanged

Triggered when a DocumentAction is modified

DocumentAnnotationSettingsChanged

Triggered when the document's Annotation Settings are changed

DocumentBleedChanged

Triggered when the document's bleed (top/left/right/bottom) is modified

DocumentClosing

Triggered when the current version of the document is closing (by opening a new document or reverting)

DocumentConstraintsChanged

Triggered when the document's constraints are modified

DocumentDefaultDirectoriesChanged

Triggered when any of the asset directories (document, user, usergroup) are changed

DocumentDimensionsChanged

Triggered when the document's dimensions are changed (width/height)

DocumentDirtyStateChanged

Triggered when the document becomes (or is no longer) dirty

DocumentEventActionAdded

A Document Event Action was added

DocumentEventActionDefinitionChanged

A Document Event Action was modified

DocumentEventActionDeleted

A Document Event Action was deleted

DocumentEventActionIndexChanged

A Document Event Action index was modified

DocumentEventActionNameChanged

A Document Event Action's name was modified

DocumentExternalThreeDUpdateNeeded

DocumentFlapChanged

Triggered when one of the document's Flap settings is modified

DocumentFoldingSettingsChanged

Triggered when the associated Fold Setting is changed

DocumentFoldSettingChanged

...

DocumentFullyLoaded

Triggered when the document is fully loaded in the editor. At this point, the Editor will start building and populating the workspace/interface

DocumentFullyRendered

Triggered when readyForConsole becomes empty for the first time

DocumentInitialViewRendered

The view of the document intially visible pages are fully initialized and rendered. 

DocumentLinkSettingsChanged

Triggered when the document's Link Settings are modified

DocumentLoaded

Triggered when the document is loaded from the server. A next step of initialization takes place internally, resulting in the DocumentFullyLoaded event (on which external JavaScripts should respond)

DocumentLoading

Triggered when a new document starts loading

DocumentOutputCreated

Triggered when the output (PDF, images, ..) has been created from a document

DocumentSaveAsRequested

Triggered when the user clicks the 'Save' or 'Save As' button in the Document Actions Toolbar item. This event can be handled in JavaScripts to prevent saving (by setting document.saveDenied to true during the event)

DocumentSaved

Triggered when a document was saved

DocumentSaveRequested

Triggered when the user clicks the 'Save' or 'Save As' button in the Document Actions Toolbar item. This event can be handled in JavaScripts to prevent saving (by setting document.saveDenied to true during the event)

DocumentSerialized

Triggered when the internal serialization of the XML of a document has been completed

DocumentSlugChanged

Triggered when the document's slug is modified (top/left/right/bottom)

DocumentSpineChanged

Triggered when any of the document's spine settings are modified

DocumentTextLanguageChanged

Triggered when the document text language has changed

DocumentThreeDModelChanged

Triggered when the associated ThreeDModel is changed

DynamicContextChanged

Triggered when the calculating context has changed, e.g. the tag of a frame has changed, the name of a Variable has changed.

FillNewTextFramesChanged

FontAdded

Triggered when a font is added to the document

FontDeleted

Triggered when a font is removed from the document

FontIndexChanged

Triggered when the index of a font is changed (based on its name)

FontLoaded

Triggered when a font is loaded from the server. The text frames using this font will be updated automatically

FontNameChanged

Triggered when the name of a font changes

FrameAdded

Triggered when a Frame is added to a page

FrameAlternateLayoutSelectionChanged

Triggered when the settings of a frame concerning its visibility in alternate layouts is changed

FrameAnchorChanged

Triggered when a frame's anchor settings are changed

FrameBarcodeSettingsChanged

Triggered when the settings of a barcode frame are changed

FrameBorderChanged

Triggered when a change is made to a frame's border (corner radius, weight, color, ...)

FrameChainChanged

Triggered when the text chain / story of a text frame is modified

FrameConstraintsChanged

Triggered when the constraints applying to a frame are modified

FrameDeleted

Triggered when a frame is deleted from a page

FrameDisplayQualityChanged

Triggered when the display quality of the image of a single frame is changed

FrameDropShadowChanged

Triggered when the dropshadow settings of a frame are modified

FrameDynamicChanged

Triggered when the frame dynamic layout configuration has changed.

FrameFillChanged

Triggered when the fill settings of a frame are changed

FrameHandlePreferencesChanged

Triggered when view preferences regarding frame handles are modified

FrameImageCompleted

Frame image downloaded and rendered

FrameIndexChanged

Triggered when the index of a frame is changed

FrameLayerChanged

Triggered when the layer of a frame is changed (more specifically when a frame is moved to another layer)

FrameLinkSettingsChanged

Triggered when the link settings of a frame are modified

FrameMoved

Triggered when a frame is moved or resized

FrameMoveFinished

Triggered when the move of a frame using drag/drop is finished (used for example to show the inline toolbars/panels once more)

FrameMoveInProgress

Called while a frame is being moved. This event is used to hide certain elements (like inline toolbars) in the interface during this action.

FrameMoveRegionChanged

Triggered when the move region for a frame is modified

FrameOpacityChanged

Triggered when the transparancy / opacity of a frame is altered

FrameReferencePointChanged

FrameResized

Trigger when a frame is resized

FrameRotated

Triggered when a frame is rotated

FrameShapeChanged

Triggered when the shape of a frame is modified

FrameTagChanged

Triggered when the tag of a frame is changed

FrameTextVariablesChanged

Triggered when a text frame is made variable (or turned into a normal frame)

FrameWrapChanged

Triggered when the wrap settings of a frame are modified

GridSettingsChanged

Triggered when the grid settings in the document's ViewPreferences are modified

HelpLayerVisibilityChanged

Triggered when the visibilty of help layers in the Editor is changed

HiddenCharacterVisibilityChanged

Triggered when the visibility of hidden characters is changed in the ViewPreferences

HighlightedFrameChanged

Triggered when the mouse is over a new frame

IconSetDownloaded

Triggered when the download of an IconSet is completed

IconSetDownloadStarted

Triggered when the download of an IconSet is started

IconSetFullDownloaded

Triggered when a full IconSet is downloaded

Idle

Called whenever the editor goes into idle mode (500ms after the last mouse movement, for example)

ImageFrameInlineCroppingToggled

Triggered when image frame toggling incline cropping mode

ImageFrameVariableDefinitionChanged

Triggered when the associated variable for an image frame is changed

InitialPreviewQualityChanged

Triggered when the document's Initial Preview Quality for images is changed in the ViewPreferences

InlineFrameAdded

An Inline Frame was added

InlineFrameDeleted

An Inline Frame was deleted

InlinePanelVisibilityChanged

Triggered when the visibility of inline panels is changed in the WorkSpace

InlineToolBarVisibilityChanged

Triggered when the visibility of inline toolbars is changed in the WorkSpace

InsertVariable

Triggered when a variable is inserted

InsertVariableCondition

Triggered when a variable condition is inserted

InsertVariableNotStoryEditor

Triggered when a variable is inserted for 

LanguageCacheRequiresClearing

Triggered when internal language caching needs to be cleared

LanguageDownloaded

Triggered when a language dictionary has been downloaded

LanguageDownloadStarted

Raised when the download of a language file starts

LayerAdded

Triggered when a layer is added to the document

LayerAlternateLayoutSelectionChanged

Triggered when the visibility of a layer depending on the selected alternate alyout is modified

LayerContentTypeChanged

Triggered when the content type of a layer has been modified

LayerDeleted

Triggered when a layer is removed from the document

LayerIndexChanged

Triggered when the index of a layer is changed

LayerMoveRegionChanged

Triggered when the move region associated with the layer is changed

LayerNameChanged

Triggered when the name of a layer is changed

LayerOpacityChanged

Triggered when the transparancy / opacity of a layer is changed

LayerPrintingChanged

Triggered when the layer's includeInOutput option is changed

LayerTextLanguageChanged

Triggered when the layer text language has changed

LayerTextWrapChanged

Triggered when the layer's noTextWrapIfInvisible option is changed

LayerVisibilityChanged

Triggered when the visibility of a layer is changed

LayerVisibleVariableChanged

Triggered when the variable associated to the layer's visibility is changed

LinkSettingsChanged

Triggered when Link Settings are modified

LinkSettingsVariableChanged

Triggered when the variable associated with Link Settings are changed

MarginVisibilityChanged

Triggered when the visibility of margins in the ViewPreferences are changed

MeasurementUnitsChanged

Triggered when the measuerement unit for the document is changed in the ViewPreferences

MoveRegionVisibilityChanged

Triggered when visibility of move regions is changed in the ViewPreferences

ObjectReplaceRequested

Triggered when an object (color, characterstyle, ...) is being deleted and has to be replaced by another object

PageAdded

Triggered when a page is added to the document

PageAlternateLayoutSelectionChanged

Triggered when the settings concerning visibility of the page in alternate layouts are modified

PageBackgroundColorChanged

Triggered when the background color for pages is changed

PageBookMarkSettingsChanged

Triggered when the bookmark settings of a page are modified

PageBorderVisibilityChanged

Triggered when the visibility of page border is changed in the ViewPreferences

PageCanvasScrollChanged

Dispatched when the scroll of the main page canvas changes (either through user input or programmatically)

PageContentTypeChanged

Triggered when the content type of a page has been modified

PageControlsLoaded

Triggered when the editor's page controls are loaded

PageCopied

Triggered when a page is copied to the document

PageDeleted

Triggered when a page is deleted from the document

PageIncludeInLayoutChanged

Triggered when a page is (or is not) included in the currently selected alternate layout

PageIncludeInOutputChanged

Triggered when the settings for a page's inclusion in output are changed

PageIndexChanged

Triggered when the index of a page is modified

PageLabelVisibilityChanged

Triggered when the visibility of page labels is changed in the ViewPreferences

PageMarginsChanged

Triggered when the margins (top/left/bottom/right) of a page are altered

PageModeChanged

Triggered when the flow mode of the pages in the Editor is changed in the ViewPreferences

PageRulerVisibilityChanged

Triggered when the visibility of page rulers is changed in the ViewPreferences

PageSectionChanged

Triggered when the section options for a page are modified

PageVisibilityModeChanged

Triggered when the visibility mode for pages which aren't included in the ouptut is changed in the ViewPreferences

PageVisibleVariableChanged

Triggered when the variable associated to the page's visibility is changed

PanelAdded

Triggered when a panel is added to the WorkSpace

PanelControlAdded

Triggered when a Panel Control is added to the WorkSpace

PanelControlDeleted

Triggered when a Panel Control is removed from the WorkSpace

PanelControlIndexChanged

Triggered when the index of a Panel Control is changed

PanelControlTitleChanged

Triggered when the title of a Panel Control is modified

PanelControlViewPreferencesChanged

Triggered when the ViewPreferences for a specific Panel Control are changed

PanelControlVisibilityChanged

Triggered when the visibility of a Panel Control is changed

PanelDeleted

Triggered when a Panel is removed from the WorkSpace

PanelIndexChanged

Triggered when the index of a panel is changed in the WorkSpace

PanelTitleChanged

Triggered when the title of a Panel is changed in the WorkSpace

PanelViewPreferencesChanged

Triggered when the viewpreferences of a Panel is changed

ParagraphStyleAdded

Triggered when a ParagraphStyle is added to the document

ParagraphStyleBackgroundDefinitionChanged

Triggered when the background definition for a ParagraphStyle is changed

ParagraphStyleColorChanged

Triggered when the text color of a ParagraphStyle is modified. This can be done by assigning a new color, or by changing the value of the assigned color

ParagraphStyleDefinitionChanged

Triggered when the definition of a ParagraphStyle is modified

ParagraphStyleDeleted

Triggered when a ParagraphStyle is removed from the document

ParagraphStyleDiagonalRuleDefinitionChanged

Triggered when the settings for the Diagonal Rule of a ParagraphStyle is modified

ParagraphStyleIndexChanged

Triggered when the index of a ParagraphStyle is changed (based on its name)

ParagraphStyleNameChanged

Triggered when the name of a ParagraphStyle is altered

ParagraphStyleRuleDefinitionChanged

Triggered when the definition of a ParagraphStyle's rule is modified

PathAdded

A Path was added

PathChanged

A Path was modified

PathCursorChanged

The cursor for the Path Editor was modified

PathDeleted

A Path was removed

PathPointAdded

A Path Point was added

PathPointDeleted

A Path Point was removed

PathPointMoved

A Path Point was moved

PDFSettingsChanged

Triggered when the selected PDF Export Settings are changed

PluginAdded

Triggered when a plugin is added to the document

PluginDeleted