User Guide

348 Document
Arguments
HTMLstr, parserCallbackObj
■ The HTMLstr argument is a string that contains code.
■ The parserCallbackObj argument is a JavaScript object that has one or more of the
following methods:
openTagBegin(), openTagEnd(), closeTagBegin(),
closeTagEnd(), directive(), attribute(), and text(). For best performance,
parserCallbackObj should be a shared library that is defined using the C-Level
Extensibility interface. Performance is also improved if
parserCallbackObj defines only
the callback functions that it needs.
Returns
A Boolean value: true if the operation completed successfully; false otherwise.
Example
The following sequence of steps provide an example of how to use the
dreamweaver.scanSourceString() function:
1. Create an implementation for one or more of the seven callback functions.
2. Write a script that calls the dreamweaver.scanSourceString() function.
3. The dreamweaver.scanSourceString() function passes a string that contains HTML
and pointers to the callback functions that you wrote. For example, the string of HTML is
"<font size=2>hello</font>".
4. Dreamweaver analyzes the string and determines that the string contains a font tag.
Dreamweaver calls the callback functions in the following sequence:
■ The openTagBegin() function
■ The attribute() function (for the size attribute)
■ The openTagEnd() function
■ The text() function (for the "hello" string)
■ The closeTagBegin() and closeTagEnd() functions
000_DW_API_Print.book Page 348 Wednesday, July 20, 2005 11:58 AM