User Guide

386 Chapter 18: Code
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 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 {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.
Example
The following code demonstrates three ways to create a searchObject object:
var searchParams;
searchParams.searchString = 'bgcolor="#FFCCFF"';
searchParams.searchSource = true;
dreamweaver.setUpFind(searchParams);
var searchParams = {searchString: 'bgcolor="#FFCCFF"', searchSource: true};
dreamweaver.setUpFind(searchParams);
dreamweaver.setUpFind({searchString: 'bgcolor="#FFCCFF"', searchSource: ¬
true});
000_DW_API_Print.book Page 386 Wednesday, August 20, 2003 9:14 AM