Adobe InDesign CS6 (8.0) Object Model JS: Event

InDesign CS6

previous page next page

Class

Event

An event.

Superclass of DocumentEvent, IdleEvent, ImportExportEvent, MutationEvent, and PrintEvent

QuickLinks

getElements, preventDefault, stopPropagation, toSource, toSpecifier

Hierarchy

Event

DocumentEvent | IdleEvent | ImportExportEvent | MutationEvent | PrintEvent

MutationEvent

Properties

Property	Type	Access	Description
bubbles	bool	readonly	If true, the event supports the bubbling phase of propagation.
cancelable	bool	readonly	If true, the default behavior of the event on its target can be canceled.
currentTarget	Object	readonly	The current propagation target of the event.
defaultPrevented	bool	readonly	If true, the default behavior of the event on its target has been canceled.
eventPhase	EventPhases: EventPhases.NOT_DISPATCHING EventPhases.AT_TARGET EventPhases.BUBBLING_PHASE EventPhases.DONE	readonly	The current propagation phase of the event.
eventType	string	readonly	The name of the event.
id	number	readonly	The unique ID of the Event.
index	number	readonly	The index of the Event within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	AlignDistributePreference AnchoredObjectDefault AnchoredObjectSetting AngleCombobox AngleEditbox AnimationBehavior AnimationSetting Application Article ArticleChild ArticleMember Asset AssignedStory Assignment AutoCorrectPreference AutoCorrectTable BackgroundTask BaselineFrameGridOption Behavior BevelAndEmbossSetting BlendingSetting Book BookContent Bookmark BorderPanel BuildingBlock Bullet Button ButtonPreference CaptionMetadataVariablePreference Cell CellStyle CellStyleGroup CellStyleMapping Change ChangeGlyphPreference ChangeGrepPreference ChangeObjectPreference ChangeTextPreference ChangeTransliteratePreference ChapterNumberPreference ChapterNumberVariablePreference Character CharacterStyle CharacterStyleGroup CharStyleMapping CheckBox CheckboxControl CjkGridPreference ClearFormBehavior ClipboardPreference ClippingPathSettings Color ColorSetting Column ComboBox CompositeFont CompositeFontEntry Condition ConditionalTextPreference ConditionSet ContentPlacerObject ContentTransparencySetting ContourOption CrossReference CrossReferenceFormat CrossReferenceSource CustomTextVariablePreference DashedStrokeStyle DataMerge DataMergeField DataMergeImagePlaceholder DataMergeOption DataMergePreference DataMergeTextPlaceholder DateVariablePreference Dialog DialogColumn DialogRow DictionaryPreference DirectionalFeatherSetting DisplayPerformancePreference DisplaySetting Document DocumentPreference DocumentPreset DottedStrokeStyle Dropdown DropShadowSetting DTD EnablingGroup EPS EPSExportPreference EPSImportPreference EPSText EPubExportPreference ExcelImportPreference ExportForWebPreference FeatherSetting FileNameVariablePreference FillTransparencySetting FindChangeBevelAndEmbossSetting FindChangeBlendingSetting FindChangeContentTransparencySetting FindChangeDirectionalFeatherSetting FindChangeDropShadowSetting FindChangeFeatherSetting FindChangeFillTransparencySetting FindChangeGlyphOption FindChangeGradientFeatherSetting FindChangeGrepOption FindChangeInnerGlowSetting FindChangeInnerShadowSetting FindChangeObjectOption FindChangeOuterGlowSetting FindChangeSatinSetting FindChangeStrokeTransparencySetting FindChangeTextOption FindChangeTransliterateOption FindChangeTransparencySetting FindGlyphPreference FindGrepPreference FindObjectPreference FindTextPreference FindTransliteratePreference FlattenerPreference FlattenerPreset Font FontLockingPreference Footnote FootnoteOption FormField FrameFittingOption GalleyPreference GeneralPreference GotoAnchorBehavior GotoFirstPageBehavior GotoLastPageBehavior GotoNextPageBehavior GotoNextStateBehavior GotoNextViewBehavior GotoPageBehavior GotoPreviousPageBehavior GotoPreviousStateBehavior GotoPreviousViewBehavior GotoStateBehavior GotoURLBehavior GrabberPreference Gradient GradientFeatherSetting GradientStop Graphic GraphicLayer GraphicLayerOption GraphicLine GridDataInformation GridPreference GridPrintingPreference Group Guide GuidePreference HiddenText HTMLExportPreference HtmlItem Hyperlink HyperlinkExternalPageDestination HyperlinkPageDestination HyperlinkPageItemSource HyperlinkTextDestination HyperlinkTextSource HyperlinkURLDestination HyphenationException IDBasedObject IdleTask Image ImageIOPreference ImagePreference IMEPreference ImportedPage ImportedPageAttribute InCopyExportOption Index IndexingSortOption IndexOptions IndexSection Ink InnerGlowSetting InnerShadowSetting InsertionPoint IntegerCombobox IntegerEditbox InteractivePDFExportPreference JPEGExportPreference KinsokuTable Language LanguageWithVendors Layer LayoutAdjustmentPreference LayoutGridDataInformation LayoutWindow Library LibraryPanel Line Link LinkedPageItemOption LinkedStoryOption LinkingPreference LinkMetadata ListBox MarginPreference MasterSpread MatchCharacterStylePreference MatchParagraphStylePreference MeasurementCombobox MeasurementEditbox MediaItem Menu MenuAction MenuElement MenuItem MenuSeparator MetadataPreference MixedInk MixedInkGroup MojikumiTable MojikumiUiPreference MotionPreset Movie MovieBehavior MultiStateObject NamedGrid NavigationPoint NestedGrepStyle NestedLineStyle NestedStyle NonIDBasedObject Note NotePreference NumberingList NumberingRestartPolicy Object ObjectExportOption ObjectStyle ObjectStyleContentEffectsCategorySettings ObjectStyleFillEffectsCategorySettings ObjectStyleGroup ObjectStyleObjectEffectsCategorySettings ObjectStyleStrokeEffectsCategorySettings OpacityGradientStop OpenFileBehavior OuterGlowSetting Oval Page PageItem PageItemDefault PageNumberVariablePreference PageReference PagesPanel Panel Paragraph ParagraphDestination ParagraphStyle ParagraphStyleGroup ParaStyleMapping PasteboardPreference Path PathPoint PDF PDFAttribute PDFExportPreference PDFExportPreset PDFPlacePreference PercentCombobox PercentEditbox PICT PlaceGun PNGExportPreference Polygon PolygonPreference Preference PreflightBookOption PreflightOption PreflightProcess PreflightProfile PreflightProfileRule PreflightRule PreflightRuleInstance PrintBookletOption PrintBookletPrintPreference PrinterPreset PrintFormBehavior PrintPreference RadioButton RadiobuttonControl RadiobuttonGroup RealCombobox RealEditbox Rectangle RootObject Row RuleDataObject SatinSetting ScriptArg ScriptMenuAction ScriptPreference Section ShowHideFieldsBehavior SignatureField SmartGuidePreference Snippet Sound SoundBehavior SpellPreference SplineItem Spread State StaticText Story StoryGridDataInformation StoryPreference StoryWindow StripedStrokeStyle StrokeFillProxySetting StrokeStyle StrokeTransparencySetting StyleExportTagMap Submenu SubmitFormBehavior Swatch SWFExportPreference Table TableStyle TableStyleGroup TableStyleMapping TabStop TaggedPDFPreference TaggedTextExportPreference TaggedTextImportPreference Text TextBox TextColumn TextDefault TextEditbox TextEditingPreference TextExportPreference TextFrame TextFramePreference TextImportPreference TextPath TextPreference TextStyleRange TextVariable TextVariableInstance TextWrapPreference TimingGroup TimingList TimingSetting TimingTarget Tint TOCStyle TOCStyleEntry ToolBox Topic TrackChangesPreference TransformationMatrix TransformPreference TransparencyPreference TransparencySetting TrapPreset UIDBasedObject UserDictionary ValidationError ViewPreference ViewZoomBehavior WatermarkPreference Widget Window WMF Word WordRTFImportPreference XFLExportPreference XMLAttribute XMLComment XMLElement XMLExportMap XMLExportPreference XMLImportMap XMLImportPreference XMLInstruction XMLItem XMLPreference XMLRuleMatchData XMLRuleProcessor XmlStory XMLTag XMLViewPreference	readonly	The parent of the Event (a Object, UIDBasedObject, CellStyleGroup, CellStyle, TableStyleGroup, Article, ConditionSet, HiddenText, Condition, MotionPreset, AssignedStory, Assignment, ObjectStyleGroup, ObjectStyle, NumberingList, Snippet, Dialog, Swatch, Color, Tint, Gradient, MixedInkGroup, MixedInk, Behavior, SubmitFormBehavior, PrintFormBehavior, ClearFormBehavior, GotoPageBehavior, GotoAnchorBehavior, SoundBehavior, ViewZoomBehavior, GotoStateBehavior, GotoPreviousStateBehavior, GotoNextStateBehavior, OpenFileBehavior, AnimationBehavior, ShowHideFieldsBehavior, MovieBehavior, GotoURLBehavior, GotoPreviousViewBehavior, GotoNextViewBehavior, GotoPreviousPageBehavior, GotoNextPageBehavior, GotoLastPageBehavior, GotoFirstPageBehavior, PreflightProfileRule, PreflightRuleInstance, PreflightProfile, CrossReferenceFormat, HyperlinkURLDestination, HyperlinkExternalPageDestination, HyperlinkPageDestination, HyperlinkTextDestination, ParagraphDestination, HyperlinkTextSource, CrossReferenceSource, HyperlinkPageItemSource, Bookmark, Hyperlink, IndexSection, PageReference, CrossReference, Index, TOCStyle, FlattenerPreset, BookContent, MenuAction, ScriptMenuAction, NamedGrid, CompositeFontEntry, CompositeFont, CharacterStyleGroup, ParagraphStyleGroup, TextVariableInstance, Footnote, XMLRuleProcessor, XMLTag, Note, TableStyle, TextPath, Asset, Link, Section, MojikumiTable, KinsokuTable, Guide, LanguageWithVendors, Language, PageItem, HtmlItem, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, MasterSpread, TrapPreset, Ink, DocumentPreset, Page, Spread, Layer, CharacterStyle, ParagraphStyle, Story, XmlStory, IDBasedObject, ArticleChild, ArticleMember, DialogRow, DialogColumn, Widget, BorderPanel, MeasurementEditbox, MeasurementCombobox, RealCombobox, AngleEditbox, PercentEditbox, RealEditbox, PercentCombobox, AngleCombobox, EnablingGroup, IntegerCombobox, IntegerEditbox, RadiobuttonControl, RadiobuttonGroup, CheckboxControl, Dropdown, StaticText, TextEditbox, BackgroundTask, State, RuleDataObject, XMLItem, DTD, XMLInstruction, XMLComment, XMLElement, Table, Cell, IdleTask, StrokeStyle, StripedStrokeStyle, DottedStrokeStyle, DashedStrokeStyle, GraphicLayer, NonIDBasedObject, TableStyleMapping, CharStyleMapping, CellStyleMapping, ParaStyleMapping, TimingTarget, TimingGroup, TimingList, OpacityGradientStop, DataMergeField, DataMergeImagePlaceholder, DataMergeTextPlaceholder, Panel, LibraryPanel, PagesPanel, Window, StoryWindow, LayoutWindow, NavigationPoint, PreflightProcess, PreflightRule, BuildingBlock, DisplaySetting, IndexingSortOption, Topic, TOCStyleEntry, MenuElement, MenuSeparator, MenuItem, Submenu, Menu, StyleExportTagMap, TextVariable, XMLRuleMatchData, ValidationError, XMLExportMap, XMLImportMap, XMLAttribute, PrinterPreset, Row, Column, Change, RootObject, Document, Application, Book, Library, Preference, ContentPlacerObject, LinkedPageItemOption, LinkedStoryOption, HTMLExportPreference, EPubExportPreference, ConditionalTextPreference, TimingSetting, AnimationSetting, XFLExportPreference, SWFExportPreference, AlignDistributePreference, GrabberPreference, ObjectStyleContentEffectsCategorySettings, ObjectStyleFillEffectsCategorySettings, ObjectStyleStrokeEffectsCategorySettings, ObjectStyleObjectEffectsCategorySettings, ChapterNumberPreference, NumberingRestartPolicy, Bullet, DataMerge, DataMergeOption, DataMergePreference, JPEGExportPreference, TrackChangesPreference, NotePreference, TransformPreference, ClipboardPreference, GeneralPreference, WatermarkPreference, ButtonPreference, PNGExportPreference, PreflightBookOption, PreflightOption, XMLViewPreference, DisplayPerformancePreference, IndexOptions, LinkMetadata, MetadataPreference, ExcelImportPreference, TaggedTextImportPreference, TaggedTextExportPreference, WordRTFImportPreference, TextExportPreference, TextImportPreference, FindChangeContentTransparencySetting, FindChangeFillTransparencySetting, FindChangeStrokeTransparencySetting, FindChangeTransparencySetting, GradientFeatherSetting, FindChangeGradientFeatherSetting, DirectionalFeatherSetting, FindChangeDirectionalFeatherSetting, ContentTransparencySetting, SatinSetting, FindChangeSatinSetting, BevelAndEmbossSetting, FindChangeBevelAndEmbossSetting, InnerGlowSetting, FindChangeInnerGlowSetting, OuterGlowSetting, FindChangeOuterGlowSetting, InnerShadowSetting, FindChangeInnerShadowSetting, FeatherSetting, FindChangeFeatherSetting, DropShadowSetting, FindChangeDropShadowSetting, BlendingSetting, FindChangeBlendingSetting, FillTransparencySetting, StrokeTransparencySetting, TransparencySetting, TransparencyPreference, FlattenerPreference, GalleyPreference, GridPrintingPreference, CjkGridPreference, StoryGridDataInformation, LayoutGridDataInformation, GridDataInformation, CaptionMetadataVariablePreference, CustomTextVariablePreference, MatchParagraphStylePreference, MatchCharacterStylePreference, FileNameVariablePreference, DateVariablePreference, ChapterNumberVariablePreference, PageNumberVariablePreference, FootnoteOption, BaselineFrameGridOption, AnchoredObjectSetting, AnchoredObjectDefault, ExportForWebPreference, XMLPreference, XMLExportPreference, XMLImportPreference, InCopyExportOption, LinkingPreference, ChangeTransliteratePreference, ChangeObjectPreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeTextPreference, FindTransliteratePreference, FindObjectPreference, FindGlyphPreference, FindGrepPreference, FindTextPreference, FindChangeTransliterateOption, FindChangeObjectOption, FindChangeGlyphOption, FindChangeGrepOption, FindChangeTextOption, ColorSetting, ScriptArg, ScriptPreference, PlaceGun, LayoutAdjustmentPreference, StrokeFillProxySetting, ImportedPageAttribute, EPSImportPreference, SmartGuidePreference, AutoCorrectPreference, SpellPreference, PolygonPreference, DictionaryPreference, FontLockingPreference, MojikumiUiPreference, ContourOption, TextWrapPreference, TextEditingPreference, FrameFittingOption, ObjectExportOption, PageItemDefault, TaggedPDFPreference, InteractivePDFExportPreference, PDFAttribute, PDFPlacePreference, PDFExportPreference, IMEPreference, GraphicLayerOption, ClippingPathSettings, ImageIOPreference, ImagePreference, ToolBox, EPSExportPreference, PrintBookletPrintPreference, PrintBookletOption, PrintPreference, ViewPreference, PasteboardPreference, MarginPreference, GuidePreference, GridPreference, DocumentPreference, TextDefault, TextPreference, TextFramePreference, StoryPreference, PathPoint, Path, GradientStop, AutoCorrectTable, UserDictionary, HyphenationException, Font, TransformationMatrix, PDFExportPreset, NestedStyle, TabStop, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, NestedGrepStyle or NestedLineStyle).
propagationStopped	bool	readonly	If true, propagation of the event beyond the current target has been stopped.
properties	Object	r/w	A property that allows setting of several properties at the same time.
target	Object	readonly	The target of the event.
timeStamp	Date	readonly	The time the event was initialized.

Class

Property	Type	Access	Description
AFTER_ACTIVATE	string	readonly	Dispatched after the Event becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_CLOSE	string	readonly	Dispatched when a Event is closing. Since the close has been committed, it can no longer be canceled. This event bubbles. This event is not cancelable. (default: afterClose)
AFTER_CONTEXT_CHANGED	string	readonly	Dispatched after the active context changes. This event bubbles. This event is not cancelable. (default: afterContextChanged)
AFTER_DELETE	string	readonly	Dispatched after a Event is deleted. This event bubbles. This event is not cancelable. (default: afterDelete)
AFTER_EMBED	string	readonly	Dispatched after a Event is embedded. This event bubbles. This event is not cancelable. (default: afterEmbed)
AFTER_INVOKE	string	readonly	Dispatched after the Event is invoked. This event does not bubble. This event is not cancelable. (default: afterInvoke)
AFTER_LINKS_CHANGED	string	readonly	Dispatched after one or more links in the Event have been added, deleted, or modified. This event bubbles. This event is not cancelable. (default: afterLinksChanged)
AFTER_MOVE	string	readonly	Dispatched after a Event is relocated from one object to another. This event bubbles. This event is not cancelable. (default: afterMove)
AFTER_NEW	string	readonly	Dispatched after a Event is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_OPEN	string	readonly	Dispatched after a Event is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_PLACE	string	readonly	Dispatched after a Event is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
AFTER_QUIT	string	readonly	Dispatched when the Event is quitting. Since the quit has been committed, it can not be canceled. This event bubbles. This event is not cancelable. (default: afterQuit)
AFTER_SELECTION_ATTRIBUTE_CHANGED	string	readonly	Dispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionAttributeChanged)
AFTER_SELECTION_CHANGED	string	readonly	Dispatched after the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionChanged)
AFTER_UNEMBED	string	readonly	Dispatched after a Event is unembedded. This event bubbles. This event is not cancelable. (default: afterUnembed)
AFTER_UPDATE	string	readonly	Dispatched after a Event is updated. This event bubbles. This event is not cancelable. (default: afterUpdate)
BEFORE_CLOSE	string	readonly	Dispatched before a Event is closed. This event bubbles. This event is cancelable. (default: beforeClose)
BEFORE_DEACTIVATE	string	readonly	Dispatched before the Event becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)
BEFORE_DELETE	string	readonly	Dispatched before a Event is deleted. This event bubbles. This event is cancelable. (default: beforeDelete)
BEFORE_DISPLAY	string	readonly	Dispatched before the Event is displayed. This event does not bubble. This event is not cancelable. (default: beforeDisplay)
BEFORE_EMBED	string	readonly	Dispatched before a Event is embedded. This event bubbles. This event is cancelable. (default: beforeEmbed)
BEFORE_INVOKE	string	readonly	Dispatched before the Event is invoked. This event does not bubble. This event is cancelable. (default: beforeInvoke)
BEFORE_MOVE	string	readonly	Dispatched before a Event is relocated from one object to another. This event bubbles. This event is cancelable. (default: beforeMove)
BEFORE_PLACE	string	readonly	Dispatched before a Event is placed. This event bubbles. This event is cancelable. (default: beforePlace)
BEFORE_QUIT	string	readonly	Dispatched before the Event is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable. (default: beforeQuit)
BEFORE_UNEMBED	string	readonly	Dispatched before a Event is unembedded. This event bubbles. This event is cancelable. (default: beforeUnembed)
BEFORE_UPDATE	string	readonly	Dispatched before a Event is updated. This event bubbles. This event is cancelable. (default: beforeUpdate)
ON_INVOKE	string	readonly	Dispatched when the Event is invoked. This event does not bubble. This event is not cancelable. (default: onInvoke)