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

InCopy CS5.5

Class

FindChangeObjectOption

 Find/change object options. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
FindChangeObjectOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
includeFootnotesbool r/wIf true, includes footnotes in the find/change query.
includeHiddenLayersbool r/wIf true, includes hidden layers in the find/change query.
includeLockedLayersForFindbool r/wIf true, includes locked layers in the find query.
includeLockedStoriesForFindbool r/wIf true, includes locked stories in the find query.
includeMasterPagesbool r/wIf true, includes master pages in the find/change query.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
objectTypeObjectTypes:
ObjectTypes.ALL_FRAMES_TYPE
ObjectTypes.TEXT_FRAMES_TYPE
ObjectTypes.GRAPHIC_FRAMES_TYPE
ObjectTypes.UNASSIGNED_FRAMES_TYPE
r/wThe object type.
parentApplication readonlyThe parent of the FindChangeObjectOption (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 FindChangeObjectOption 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 FindChangeObjectOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.findChangeObjectOptions

Return

Array of FindChangeObjectOption FindChangeObjectOption.getElements ()

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