Adobe InDesign CS5 Server (7.0) Object Model JS: FindChangeTextOption

InDesign Server CS5

Class

FindChangeTextOption

 Find/change text options. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
FindChangeTextOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
caseSensitivebool r/wIf 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.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
ignoreDiacriticsbool r/wIf true, ignore diacs in the find/change query.
ignoreKashidasbool r/wIf true, ignore kashidas in the find/change query.
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.
kanaSensitivebool r/wIf true, finds only text that matches the specified kana type.
parentApplication readonlyThe parent of the FindChangeTextOption (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
wholeWordbool r/wIf true, finds only the complete find text string. If false, also finds strings that contain the find text string.
widthSensitivebool r/wIf true, finds only text that matches the specified character width.

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 FindChangeTextOption 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 FindChangeTextOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.findChangeTextOptions

Return

Array of FindChangeTextOption FindChangeTextOption.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index