Packagecom.adobe.indesign
Classpublic class FindChangeTextOption
InheritanceFindChangeTextOption Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  caseSensitive : Boolean
If true, finds strings whose use of case matches the find text string.
FindChangeTextOption
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
FindChangeTextOption
  events : Events
[override] [read-only] A collection of events.
FindChangeTextOption
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  ignoreDiacritics : Boolean
If true, ignore diacs in the find/change query.
FindChangeTextOption
  ignoreKashidas : Boolean
If true, ignore kashidas in the find/change query.
FindChangeTextOption
  includeFootnotes : Boolean
If true, includes footnotes in the find/change query.
FindChangeTextOption
  includeHiddenLayers : Boolean
If true, includes hidden layers in the find/change query.
FindChangeTextOption
  includeLockedLayersForFind : Boolean
If true, includes locked layers in the find query.
FindChangeTextOption
  includeLockedStoriesForFind : Boolean
If true, includes locked stories in the find query.
FindChangeTextOption
  includeMasterPages : Boolean
If true, includes master pages in the find/change query.
FindChangeTextOption
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
FindChangeTextOption
  kanaSensitive : Boolean
If true, finds only text that matches the specified kana type.
FindChangeTextOption
  parent : Object
[override] [read-only] The parent of the FindChangeTextOption (a Application).
FindChangeTextOption
  properties : Object
[override] A property that allows setting of several properties at the same time.
FindChangeTextOption
  wholeWord : Boolean
If true, finds only the complete find text string.
FindChangeTextOption
  widthSensitive : Boolean
If true, finds only text that matches the specified character width.
FindChangeTextOption
Public Methods
 MethodDefined By
  
addEventListenerFindChangeTextOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
FindChangeTextOption
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
FindChangeTextOption
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerFindChangeTextOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
FindChangeTextOption
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
FindChangeTextOption
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
caseSensitiveproperty
caseSensitive:Boolean

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.


Implementation
    public function get caseSensitive():Boolean
    public function set caseSensitive(value:Boolean):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
ignoreDiacriticsproperty 
ignoreDiacritics:Boolean

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


Implementation
    public function get ignoreDiacritics():Boolean
    public function set ignoreDiacritics(value:Boolean):void
ignoreKashidasproperty 
ignoreKashidas:Boolean

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


Implementation
    public function get ignoreKashidas():Boolean
    public function set ignoreKashidas(value:Boolean):void
includeFootnotesproperty 
includeFootnotes:Boolean

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


Implementation
    public function get includeFootnotes():Boolean
    public function set includeFootnotes(value:Boolean):void
includeHiddenLayersproperty 
includeHiddenLayers:Boolean

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


Implementation
    public function get includeHiddenLayers():Boolean
    public function set includeHiddenLayers(value:Boolean):void
includeLockedLayersForFindproperty 
includeLockedLayersForFind:Boolean

If true, includes locked layers in the find query.


Implementation
    public function get includeLockedLayersForFind():Boolean
    public function set includeLockedLayersForFind(value:Boolean):void
includeLockedStoriesForFindproperty 
includeLockedStoriesForFind:Boolean

If true, includes locked stories in the find query.


Implementation
    public function get includeLockedStoriesForFind():Boolean
    public function set includeLockedStoriesForFind(value:Boolean):void
includeMasterPagesproperty 
includeMasterPages:Boolean

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


Implementation
    public function get includeMasterPages():Boolean
    public function set includeMasterPages(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
kanaSensitiveproperty 
kanaSensitive:Boolean

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


Implementation
    public function get kanaSensitive():Boolean
    public function set kanaSensitive(value:Boolean):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the FindChangeTextOption (a Application).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
wholeWordproperty 
wholeWord:Boolean

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


Implementation
    public function get wholeWord():Boolean
    public function set wholeWord(value:Boolean):void
widthSensitiveproperty 
widthSensitive:Boolean

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


Implementation
    public function get widthSensitive():Boolean
    public function set widthSensitive(value:Boolean):void
Method Detail
addEventListenerFindChangeTextOption()method
public function addEventListenerFindChangeTextOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerFindChangeTextOption()method 
public function removeEventListenerFindChangeTextOption(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String