The Reports Api - MACROMEDIA DREAMWEAVER 8-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
function, or the
addResultItem()
the 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
target
one of the following values:
(for the selected files in a site), or
(for example,
selected"
256 Reports
dw.ResultsPalette.SiteReports()
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"
"Folder:
"Folder:c:temp"
processFile()
function to return information about
, ,
"CurrentSite" "CurrentSiteSelection"
+
the path to the folder the user
).
function. All other
function, the