Adobe InCopy CS5.5 (7.5) Object Model JS: Event

InCopy CS5.5

Class

Event

 

An event.

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

QuickLinks

getElements, preventDefault, stopPropagation, toSource, toSpecifier

Hierarchy

AnchoredObjectDefault | AnchoredObjectSetting | AngleCombobox | AngleEditbox | AnimationBehavior | Application | AssignedStory | Assignment | AutoCorrectPreference | AutoCorrectTable | BackgroundTask | BaselineFrameGridOption | Behavior | BorderPanel | BuildingBlock | Bullet | Button | CaptionMetadataVariablePreference | Cell | CellStyle | CellStyleGroup | Change | ChangeGlyphPreference | ChangeGrepPreference | ChangeTextPreference | ChangeTransliteratePreference | ChapterNumberVariablePreference | Character | CharacterStyle | CharacterStyleGroup | CheckboxControl | ClipboardPreference | ClippingPathSettings | Color | Column | Condition | ConditionalTextPreference | ConditionSet | ContourOption | CrossReferenceFormat | CrossReferenceSource | CustomTextVariablePreference | DateVariablePreference | Dialog | DialogColumn | DialogRow | DictionaryPreference | Document | DocumentPreference | DocumentPreset | Dropdown | DTD | EnablingGroup | EPS | EPSText | ExcelImportPreference | ExportForWebPreference | FileNameVariablePreference | FindChangeGlyphOption | FindChangeGrepOption | FindChangeObjectOption | FindChangeTextOption | FindChangeTransliterateOption | FindGlyphPreference | FindGrepPreference | FindTextPreference | FindTransliteratePreference | Font | Footnote | FootnoteOption | FormField | FrameFittingOption | GalleyPreference | GalleyPrintPreference | GeneralPreference | GotoAnchorBehavior | GotoFirstPageBehavior | GotoLastPageBehavior | GotoNextPageBehavior | GotoNextStateBehavior | GotoNextViewBehavior | GotoPageBehavior | GotoPreviousPageBehavior | GotoPreviousStateBehavior | GotoPreviousViewBehavior | GotoStateBehavior | GotoURLBehavior | Gradient | GradientStop | Graphic | GraphicLayer | GraphicLayerOption | GraphicLine | GridPreference | Group | Guide | GuidePreference | HiddenText | Hyperlink | HyperlinkExternalPageDestination | HyperlinkPageItemSource | HyperlinkTextDestination | HyperlinkTextSource | HyperlinkURLDestination | HyphenationException | IDBasedObject | IdleTask | Image | ImageIOPreference | ImagePreference | IMEPreference | ImportedPage | ImportedPageAttribute | InCopyExportOption | IndexingSortOption | Ink | InsertionPoint | IntegerCombobox | IntegerEditbox | KinsokuTable | Language | LanguageWithVendors | Layer | LayoutPrintPreference | Line | Link | LinkingPreference | LinkMetadata | MarginPreference | MasterSpread | MatchCharacterStylePreference | MatchParagraphStylePreference | MeasurementCombobox | MeasurementEditbox | MediaItem | Menu | MenuAction | MenuElement | MenuItem | MenuSeparator | MetadataPreference | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | Movie | MovieBehavior | MultiStateObject | NavigationPoint | NestedGrepStyle | NestedLineStyle | NestedStyle | NonIDBasedObject | Note | NotePreference | NumberingList | NumberingRestartPolicy | Object | OpenFileBehavior | Oval | Page | PageItem | PageItemDefault | PageNumberVariablePreference | Panel | Paragraph | ParagraphDestination | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | Path | PathPoint | PDF | PDFGalleyExportPreference | PDFLayoutExportPreference | PercentCombobox | PercentEditbox | PICT | PlaceGun | Polygon | Preference | RadiobuttonControl | RadiobuttonGroup | RealCombobox | RealEditbox | Rectangle | RootObject | Row | ScriptArg | ScriptMenuAction | ScriptPreference | Section | ShowHideFieldsBehavior | Sound | SoundBehavior | SpellPreference | SplineItem | Spread | State | StaticText | Story | StoryPreference | StrokeFillProxySetting | StrokeStyle | StyleExportTagMap | Submenu | Swatch | Table | TableStyle | TableStyleGroup | TabStop | TaggedTextExportPreference | TaggedTextImportPreference | Text | TextColumn | TextDefault | TextEditbox | TextEditingPreference | TextExportPreference | TextFrame | TextFramePreference | TextImportPreference | TextMacro | TextPath | TextPreference | TextStyleRange | TextVariable | TextVariableInstance | TextWrapPreference | Tint | ToolBox | TrackChangesPreference | TransformationMatrix | TrapPreset | UIDBasedObject | UserDictionary | ValidationError | ViewPreference | ViewZoomBehavior | Widget | Window | WMF | Word | WordRTFImportPreference | XMLAttribute | XMLComment | XMLElement | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLInstruction | XMLItem | XMLPreference | XmlStory | XMLTag | XMLViewPreference
Event
DocumentEvent | IdleEvent | ImportExportEvent | MutationEvent | PrintEvent
MutationEvent

Properties

PropertyTypeAccessDescription
bubblesbool readonlyIf true, the event supports the bubbling phase of propagation.
cancelablebool readonlyIf true, the default behavior of the event on its target can be canceled.
currentTargetObject readonlyThe current propagation target of the event.
defaultPreventedbool readonlyIf true, the default behavior of the event on its target has been canceled.
eventPhaseEventPhases:
EventPhases.NOT_DISPATCHING
EventPhases.AT_TARGET
EventPhases.BUBBLING_PHASE
EventPhases.DONE
readonlyThe current propagation phase of the event.
eventTypestring readonlyThe name of the event.
idnumber readonlyThe unique ID of the Event.
indexnumber readonlyThe index of the Event within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentAnchoredObjectDefault
AnchoredObjectSetting
AngleCombobox
AngleEditbox
AnimationBehavior
Application
AssignedStory
Assignment
AutoCorrectPreference
AutoCorrectTable
BackgroundTask
BaselineFrameGridOption
Behavior
BorderPanel
BuildingBlock
Bullet
Button
CaptionMetadataVariablePreference
Cell
CellStyle
CellStyleGroup
Change
ChangeGlyphPreference
ChangeGrepPreference
ChangeTextPreference
ChangeTransliteratePreference
ChapterNumberVariablePreference
Character
CharacterStyle
CharacterStyleGroup
CheckboxControl
ClipboardPreference
ClippingPathSettings
Color
Column
Condition
ConditionalTextPreference
ConditionSet
ContourOption
CrossReferenceFormat
CrossReferenceSource
CustomTextVariablePreference
DateVariablePreference
Dialog
DialogColumn
DialogRow
DictionaryPreference
Document
DocumentPreference
DocumentPreset
Dropdown
DTD
EnablingGroup
EPS
EPSText
ExcelImportPreference
ExportForWebPreference
FileNameVariablePreference
FindChangeGlyphOption
FindChangeGrepOption
FindChangeObjectOption
FindChangeTextOption
FindChangeTransliterateOption
FindGlyphPreference
FindGrepPreference
FindTextPreference
FindTransliteratePreference
Font
Footnote
FootnoteOption
FormField
FrameFittingOption
GalleyPreference
GalleyPrintPreference
GeneralPreference
GotoAnchorBehavior
GotoFirstPageBehavior
GotoLastPageBehavior
GotoNextPageBehavior
GotoNextStateBehavior
GotoNextViewBehavior
GotoPageBehavior
GotoPreviousPageBehavior
GotoPreviousStateBehavior
GotoPreviousViewBehavior
GotoStateBehavior
GotoURLBehavior
Gradient
GradientStop
Graphic
GraphicLayer
GraphicLayerOption
GraphicLine
GridPreference
Group
Guide
GuidePreference
HiddenText
Hyperlink
HyperlinkExternalPageDestination
HyperlinkPageItemSource
HyperlinkTextDestination
HyperlinkTextSource
HyperlinkURLDestination
HyphenationException
IDBasedObject
IdleTask
Image
ImageIOPreference
ImagePreference
IMEPreference
ImportedPage
ImportedPageAttribute
InCopyExportOption
IndexingSortOption
Ink
InsertionPoint
IntegerCombobox
IntegerEditbox
KinsokuTable
Language
LanguageWithVendors
Layer
LayoutPrintPreference
Line
Link
LinkingPreference
LinkMetadata
MarginPreference
MasterSpread
MatchCharacterStylePreference
MatchParagraphStylePreference
MeasurementCombobox
MeasurementEditbox
MediaItem
Menu
MenuAction
MenuElement
MenuItem
MenuSeparator
MetadataPreference
MixedInk
MixedInkGroup
MojikumiTable
MojikumiUiPreference
Movie
MovieBehavior
MultiStateObject
NavigationPoint
NestedGrepStyle
NestedLineStyle
NestedStyle
NonIDBasedObject
Note
NotePreference
NumberingList
NumberingRestartPolicy
Object
OpenFileBehavior
Oval
Page
PageItem
PageItemDefault
PageNumberVariablePreference
Panel
Paragraph
ParagraphDestination
ParagraphStyle
ParagraphStyleGroup
PasteboardPreference
Path
PathPoint
PDF
PDFGalleyExportPreference
PDFLayoutExportPreference
PercentCombobox
PercentEditbox
PICT
PlaceGun
Polygon
Preference
RadiobuttonControl
RadiobuttonGroup
RealCombobox
RealEditbox
Rectangle
RootObject
Row
ScriptArg
ScriptMenuAction
ScriptPreference
Section
ShowHideFieldsBehavior
Sound
SoundBehavior
SpellPreference
SplineItem
Spread
State
StaticText
Story
StoryPreference
StrokeFillProxySetting
StrokeStyle
StyleExportTagMap
Submenu
Swatch
Table
TableStyle
TableStyleGroup
TabStop
TaggedTextExportPreference
TaggedTextImportPreference
Text
TextColumn
TextDefault
TextEditbox
TextEditingPreference
TextExportPreference
TextFrame
TextFramePreference
TextImportPreference
TextMacro
TextPath
TextPreference
TextStyleRange
TextVariable
TextVariableInstance
TextWrapPreference
Tint
ToolBox
TrackChangesPreference
TransformationMatrix
TrapPreset
UIDBasedObject
UserDictionary
ValidationError
ViewPreference
ViewZoomBehavior
Widget
Window
WMF
Word
WordRTFImportPreference
XMLAttribute
XMLComment
XMLElement
XMLExportMap
XMLExportPreference
XMLImportMap
XMLImportPreference
XMLInstruction
XMLItem
XMLPreference
XmlStory
XMLTag
XMLViewPreference
readonlyThe parent of the Event (a Object, UIDBasedObject, CellStyleGroup, CellStyle, TableStyleGroup, ConditionSet, HiddenText, Condition, AssignedStory, Assignment, NumberingList, Dialog, Swatch, Color, Tint, Gradient, MixedInkGroup, MixedInk, Behavior, GotoPageBehavior, GotoAnchorBehavior, SoundBehavior, ViewZoomBehavior, GotoStateBehavior, GotoPreviousStateBehavior, GotoNextStateBehavior, OpenFileBehavior, AnimationBehavior, ShowHideFieldsBehavior, MovieBehavior, GotoURLBehavior, GotoPreviousViewBehavior, GotoNextViewBehavior, GotoPreviousPageBehavior, GotoNextPageBehavior, GotoLastPageBehavior, GotoFirstPageBehavior, CrossReferenceFormat, HyperlinkURLDestination, HyperlinkExternalPageDestination, HyperlinkTextDestination, ParagraphDestination, HyperlinkTextSource, CrossReferenceSource, HyperlinkPageItemSource, Hyperlink, MenuAction, ScriptMenuAction, CharacterStyleGroup, ParagraphStyleGroup, TextVariableInstance, Footnote, XMLTag, Note, TableStyle, TextPath, Link, Section, MojikumiTable, KinsokuTable, Guide, LanguageWithVendors, Language, PageItem, FormField, 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, DialogRow, DialogColumn, Widget, BorderPanel, MeasurementEditbox, MeasurementCombobox, RealCombobox, AngleEditbox, PercentEditbox, RealEditbox, PercentCombobox, AngleCombobox, EnablingGroup, IntegerCombobox, IntegerEditbox, RadiobuttonControl, RadiobuttonGroup, CheckboxControl, Dropdown, StaticText, TextEditbox, BackgroundTask, State, XMLItem, DTD, XMLInstruction, XMLComment, XMLElement, Table, Cell, IdleTask, StrokeStyle, GraphicLayer, NonIDBasedObject, Panel, Window, NavigationPoint, BuildingBlock, IndexingSortOption, TextMacro, MenuElement, MenuSeparator, MenuItem, Submenu, Menu, StyleExportTagMap, TextVariable, ValidationError, XMLExportMap, XMLImportMap, XMLAttribute, Row, Column, Change, RootObject, Document, Application, Preference, ConditionalTextPreference, NumberingRestartPolicy, Bullet, TrackChangesPreference, NotePreference, GalleyPrintPreference, LayoutPrintPreference, ClipboardPreference, GeneralPreference, XMLViewPreference, LinkMetadata, MetadataPreference, ExcelImportPreference, TaggedTextImportPreference, TaggedTextExportPreference, WordRTFImportPreference, TextExportPreference, TextImportPreference, GalleyPreference, CaptionMetadataVariablePreference, CustomTextVariablePreference, MatchParagraphStylePreference, MatchCharacterStylePreference, FileNameVariablePreference, DateVariablePreference, ChapterNumberVariablePreference, PageNumberVariablePreference, FootnoteOption, BaselineFrameGridOption, AnchoredObjectSetting, AnchoredObjectDefault, ExportForWebPreference, XMLPreference, XMLExportPreference, XMLImportPreference, InCopyExportOption, LinkingPreference, ChangeTransliteratePreference, ChangeGlyphPreference, ChangeGrepPreference, ChangeTextPreference, FindTransliteratePreference, FindGlyphPreference, FindGrepPreference, FindTextPreference, FindChangeTransliterateOption, FindChangeObjectOption, FindChangeGlyphOption, FindChangeGrepOption, FindChangeTextOption, ScriptArg, ScriptPreference, PlaceGun, StrokeFillProxySetting, ImportedPageAttribute, AutoCorrectPreference, SpellPreference, DictionaryPreference, MojikumiUiPreference, ContourOption, TextWrapPreference, TextEditingPreference, FrameFittingOption, PageItemDefault, PDFLayoutExportPreference, PDFGalleyExportPreference, IMEPreference, GraphicLayerOption, ClippingPathSettings, ImageIOPreference, ImagePreference, ToolBox, ViewPreference, PasteboardPreference, MarginPreference, GuidePreference, GridPreference, DocumentPreference, TextDefault, TextPreference, TextFramePreference, StoryPreference, PathPoint, Path, GradientStop, AutoCorrectTable, UserDictionary, HyphenationException, Font, TransformationMatrix, NestedStyle, TabStop, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, NestedGrepStyle or NestedLineStyle).
propagationStoppedbool readonlyIf true, propagation of the event beyond the current target has been stopped.
propertiesObject r/wA property that allows setting of several properties at the same time.
targetObject readonlyThe target of the event.
timeStampDate readonlyThe time the event was initialized.

Class

PropertyTypeAccessDescription
AFTER_ACTIVATEstring readonlyDispatched after the Event becomes active. This event bubbles. This event is not cancelable. (default: afterActivate)
AFTER_CLOSEstring readonlyDispatched 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_CHANGEDstring readonlyDispatched after the active context changes. This event bubbles. This event is not cancelable. (default: afterContextChanged)
AFTER_DELETEstring readonlyDispatched after a Event is deleted. This event bubbles. This event is not cancelable. (default: afterDelete)
AFTER_EMBEDstring readonlyDispatched after a Event is embedded. This event bubbles. This event is not cancelable. (default: afterEmbed)
AFTER_INVOKEstring readonlyDispatched after the Event is invoked. This event does not bubble. This event is not cancelable. (default: afterInvoke)
AFTER_LINKS_CHANGEDstring readonlyDispatched 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_MOVEstring readonlyDispatched after a Event is relocated from one object to another. This event bubbles. This event is not cancelable. (default: afterMove)
AFTER_NEWstring readonlyDispatched after a Event is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_OPENstring readonlyDispatched after a Event is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_PLACEstring readonlyDispatched after a Event is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
AFTER_QUITstring readonlyDispatched 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_CHANGEDstring readonlyDispatched after an attribute on the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionAttributeChanged)
AFTER_SELECTION_CHANGEDstring readonlyDispatched after the active selection changes. This event bubbles. This event is not cancelable. (default: afterSelectionChanged)
AFTER_UNEMBEDstring readonlyDispatched after a Event is unembedded. This event bubbles. This event is not cancelable. (default: afterUnembed)
AFTER_UPDATEstring readonlyDispatched after a Event is updated. This event bubbles. This event is not cancelable. (default: afterUpdate)
BEFORE_CLOSEstring readonlyDispatched before a Event is closed. This event bubbles. This event is cancelable. (default: beforeClose)
BEFORE_DEACTIVATEstring readonlyDispatched before the Event becomes inactive. This event bubbles. This event is not cancelable. (default: beforeDeactivate)
BEFORE_DELETEstring readonlyDispatched before a Event is deleted. This event bubbles. This event is cancelable. (default: beforeDelete)
BEFORE_DISPLAYstring readonlyDispatched before the Event is displayed. This event does not bubble. This event is not cancelable. (default: beforeDisplay)
BEFORE_EMBEDstring readonlyDispatched before a Event is embedded. This event bubbles. This event is cancelable. (default: beforeEmbed)
BEFORE_INVOKEstring readonlyDispatched before the Event is invoked. This event does not bubble. This event is cancelable. (default: beforeInvoke)
BEFORE_MOVEstring readonlyDispatched before a Event is relocated from one object to another. This event bubbles. This event is cancelable. (default: beforeMove)
BEFORE_PLACEstring readonlyDispatched before a Event is placed. This event bubbles. This event is cancelable. (default: beforePlace)
BEFORE_QUITstring readonlyDispatched before the Event is quit. Allows the quit to be canceled. This event bubbles. This event is cancelable. (default: beforeQuit)
BEFORE_UNEMBEDstring readonlyDispatched before a Event is unembedded. This event bubbles. This event is cancelable. (default: beforeUnembed)
BEFORE_UPDATEstring readonlyDispatched before a Event is updated. This event bubbles. This event is cancelable. (default: beforeUpdate)
ON_INVOKEstring readonlyDispatched when the Event is invoked. This event does not bubble. This event is not cancelable. (default: onInvoke)

Methods

Instances

Array of Event getElements ()
Resolves the object specifier, creating an array of object references.

void preventDefault ()
Cancels the default behavior of the event on its target.

void stopPropagation ()
Stops propagation of the event beyond the current target.

string toSource ()
Generates a string which, if executed, will return the Event.

string toSpecifier ()
Retrieves the object specifier.

Used in:

Event Events.nextItem (obj: Event)

Event Events.previousItem (obj: Event)

Return

Array of Event Event.getElements ()

Event Events.[] (index: number)

Event Events.anyItem ()

Array of Event Events.everyItem ()

Event Events.firstItem ()

Event Events.item (index: varies)

Event Events.itemByID (id: number)

Array of Event Events.itemByRange (from: varies, to: varies)

Event Events.lastItem ()

Event Events.middleItem ()

Event Events.nextItem (obj: Event)

Event Events.previousItem (obj: Event)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index