Adobe InCopy CS6 (8.0) Object Model JS: LinkingPreference

InCopy CS6

Class

LinkingPreference

 Linking preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
LinkingPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
checkLinksAtOpenbool r/wIf true, link states will be checked at document open time
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
findMissingLinksAtOpenbool r/wIf true, missing links will be searched for at document open time
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication readonlyThe parent of the LinkingPreference (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.linkingPreferences

Return

Array of LinkingPreference LinkingPreference.getElements ()

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