K4 InDesign Javascript API Documentation

PreferencesFindChangeObjectOption

Find/change object options.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
includeFootnotes bool If true, includes footnotes in the find/change query. read-write
includeHiddenLayers bool If true, includes hidden layers in the find/change query. read-write
includeLockedLayersForFind bool If true, includes locked layers in the find query. read-write
includeLockedStoriesForFind bool If true, includes locked stories in the find query. read-write
includeMasterPages bool If true, includes master pages in the find/change query. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
objectType ObjectTypes The object type. read-write
parent Application The parent of the FindChangeObjectOption (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → FindChangeObjectOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → FindChangeObjectOption
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the FindChangeObjectOption.
toSpecifier(
)
  → string
Retrieves the object specifier.