Dreamweaver.setupfind(), Dreamweaver.setupfindreplace() – Adobe Dreamweaver API Reference CS5 User Manual

Page 453

Advertising
background image

448

DREAMWEAVER API REFERENCE

Code

Last updated 8/27/2013

dreamweaver.setUpFind()

Availability
Dreamweaver 3.

Description
Prepares for a text or HTML source search by defining the search parameters for a subsequent

dreamweaver.findNext()

operation.

Arguments
searchObject

The searchObject argument is an object for which the following properties can be defined:

The searchString is the text for which to search.

The searchWhat is the location where the search should operate. The possible values are:

document

- Search in the current active document.

allOpenDocuments

- Search in all the open documents.

site

- Search in the current site.

selectedFiles

- Search in the selected files.

selectedText

- Search within the selected text or a folder path.

The searchSource property is a Boolean value that indicates whether to search the HTML source.

The {matchCase} property, which is optional, is a Boolean value that indicates whether the search is case-sensitive.
If this property is not explicitly set, it defaults to

false

.

The {matchWholeWord} property, which is optional, is a Boolean value that indicates whether the matches should
be whole words.

The {ignoreWhitespace} property, which is optional, is a Boolean value that indicates whether white space
differences should be ignored. The ignoreWhitespace property defaults to

false

if the value of the

useRegularExpressions property is

true

, and

true

if the useRegularExpressions property is

false.

The {useRegularExpressions} property is a Boolean value that indicates whether the

searchString

property uses

regular expressions. If this property is not explicitly set, it defaults to a value of

false

.

Returns
Nothing.

dreamweaver.setUpFindReplace()

Availability
Dreamweaver 3.

Description
Prepares for a text or HTML source search by defining the search parameters and the scope for a subsequent

dreamweaver.replace()

or

dreamweaver.replaceAll()

operation.

Advertising