MACROMEDIA DREAMWEAVER MX 2004-DREAMWEAVER API, Reference

Page: 174 / 486

174 Chapter 12: Workspace
Returns
A Boolean value:
true
if the item was added successfully;
false
otherwise.
Example
The following example creates a Results window called
resWin
that has the column headings:
Frodo, Sam, and Gollum. The call to the
resWin.addItem()
function adds a folder icon and
then the three strings,
msg1
,
msg2
, and
msg3
into the three columns defined for the window.
var resWin = dw.createResultsWindow("Test Window", ["Frodo", "Sam",
"Gollum"]);
resWin.addItem(resWin, "3", "Description", null, null, null, ["msg1", "msg2",
"msg3"]);
resWin.addResultItem()
Availability
Dreamweaver 4.
Description
Adds a new results entry to the current Results window, based on the information in the file that
the
processfile()
function processes.
Note: Use only on the built-in results window for Site Reports
(dreamweaver.resultsPalette.siteReports). resWin.addResultItem() cannot be used with other built-in
results windows or stand-alone results windows created with
dreamweaver.createResultsWindow() .
This function is only available in the
processFile()
callback of a site report. See “Reports” in
Extending Dreamweaver for details on site reports.
Arguments
strFilePath, strIcon
,
strDisplay, strDesc, {iLineNo}, {iStartSel}, {iEndSel}
•
The
strFilePath
argument is a fully qualified URL path of the file to process.
•
The
strIcon
argument is the path to the icon to use. To display a built-in icon, use a value "1"
through "10" instead of the fully qualified path for the icon (use "0" for no icon). The
following table shows the icons that correspond to the values of "1" through "10":
•
The
strDisplay
argument is the string to display to the user in first column of the Results
window (usually, the filename).
•
The
strDesc
argument is the description that goes with the entry.
•
The
iLineNo
argument is the number of lines in the file (optional).
•
The
iStartSel
argument is the start of offset into the file (optional, but if it is used, the
iEndSel
argument must also be used.).
•
The
iEndSel
argument is the end of offset into the file (required if
iStartSel
is used).
000_DW_API_Print.book Page 174 Wednesday, August 20, 2003 9:14 AM