beautypg.com

Beginreporting(), Endreporting(), Commandbuttons() – Adobe Extending Dreamweaver CS4 User Manual

Page 205

background image

199

EXTENDING DREAMWEAVER CS4

Reports

Arguments
strFilePath

The strFilePath argument is the full path and filename of the file to process.

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

false

value from this function, the Report command is excluded from the report run.

Arguments
target

The target argument is a string that indicates the target of the report session. It can be one of the following values:

"CurrentDoc"

,

"CurrentSite"

,

"CurrentSiteSelection"

(for the selected files in a site), or

"Folder:

+ the path

to the folder the user selected" (for example,

"Folder:c:temp"

).

Returns
Dreamweaver expects a Boolean value:

true

if the report runs successfully;

false

if target is excluded from the report run.

endReporting()

Availability
Dreamweaver 4.

Description
This function is called at the end of the Report process.

Arguments
None.

Returns
Dreamweaver expects nothing.

commandButtons()

Availability
Dreamweaver 4.

This manual is related to the following products: