FindChangeTextOption

Find/change text options.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object

Hierarchy:

Superclass: Preference

Class: FindChangeTextOption

Property Listing

Property

Type

Access

Description

caseSensitive

Boolean

read/write

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.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

ignoreDiacritics

Boolean

read/write

If true, ignore diacs in the find/change query.

ignoreKashidas

Boolean

read/write

If true, ignore kashidas in the find/change query.

includeFootnotes

Boolean

read/write

If true, includes footnotes in the find/change query.

includeHiddenLayers

Boolean

read/write

If true, includes hidden layers in the find/change query.

includeLockedLayersForFind

Boolean

read/write

If true, includes locked layers in the find query.

includeLockedStoriesForFind

Boolean

read/write

If true, includes locked stories in the find query.

includeMasterPages

Boolean

read/write

If true, includes master pages in the find/change query.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

kanaSensitive

Boolean

read/write

If true, finds only text that matches the specified kana type.

parent

Application

readonly

The parent of the FindChangeTextOption (a Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

searchBackwards

Boolean

read/write

If true, search in the backward direction.

wholeWord

Boolean

read/write

If true, finds only the complete find text string. If false, also finds strings that contain the find text string.

widthSensitive

Boolean

read/write

If true, finds only text that matches the specified character width.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

FindChangeTextOption getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the FindChangeTextOption.

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.findChangeTextOptions

Event.parent

EventListener.parent

MutationEvent.parent

Return

FindChangeTextOption.getElements()