The Reports Api; Processfile(); Beginreporting() - MACROMEDIA DREAMWEAVER MX 2004-EXTENDING DREAMWEAVER Manual

The Reports API

The only required function for the Reports API is the
functions are optional.

processFile()

Availability
Dreamweaver 4.
Description
This function is called when there is a file to process. The Report command should process the
file without modifying it and use the
addResultItem()
file. Dreamweaver automatically releases each file's DOM when it finishes.
Arguments
strFilePath
•
The
strFilePath
Returns
Dreamweaver expects nothing.

beginReporting()

Availability
Dreamweaver 4.
Description
This function is called at the start of the reporting process, before any reports are run. If the
Report command returns a
from the report run.
Arguments
target
•
The argument is a string that indicates the target of the report session. It can be one of
target
the following values:
selected files in a site), or
example,
"Folder:c:temp"
Returns
Dreamweaver expects a Boolean value:
excluded from the report run.
dw.ResultsPalette.SiteReports()
function, or the
resWin.addItem()
argument is the full path and filename of the file to process.
value from this function, the Report command is excluded
false
,
"CurrentDoc" "CurrentSite"
+
"Folder: the path to the folder the user selected"
).
true
processFile()
function to return information about the
,
"CurrentSiteSelection"
if the report runs successfully;
function. All other
function, the
(for the
(for
if is
false target
The Reports API 199