K4 InDesign Javascript API Documentation

PreferencesFindChangeTextOption

Find/change text options.

Extends

Instance Properties

Name Description Access
caseSensitive bool If true, finds strings whose use of case matches the find text string. If false, finds strings that match the find text string regardless of case. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
ignoreDiacritics bool If true, ignore diacs in the find/change query. read-write
ignoreKashidas bool If true, ignore kashidas in the find/change query. read-write
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
kanaSensitive bool If true, finds only text that matches the specified kana type. read-write
parent Application The parent of the FindChangeTextOption (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
searchBackwards bool If true, search in the backward direction. read-write
wholeWord bool If true, finds only the complete find text string. If false, also finds strings that contain the find text string. read-write
widthSensitive bool If true, finds only text that matches the specified character width. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → FindChangeTextOption
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(
)
  → FindChangeTextOption
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 FindChangeTextOption.
toSpecifier(
)
  → string
Retrieves the object specifier.