User Guide

256 Chapter 15: Server Behaviors
displayHelp()
Description
If this function is defined, a Help button appears below the OK and Cancel buttons in the dialog
box. This function is called when the user clicks the Help button.
Arguments
None.
Returns
Dreamweaver expects nothing.
Example
// the following instance of displayHelp() opens
// in a browser a file that explains how to use
// the extension.
function displayHelp(){
var myHelpFile = dw.getConfigurationPath() +
'/ExtensionsHelp/superDuperHelp.htm';
dw.browseDocument(myHelpFile);
}
findServerBehaviors()
Availability
Dreamweaver UltraDev 1.
Description
Searches the user’s document for instances of itself. For each instance it finds, the
findServerBehaviors() function creates a JavaScript object, and it attaches state information as
JavaScript properties of the object.
The four required properties are
incomplete, participants, title, and selectedNode. You
can set additional properties as necessary.
For more information, see dwscripts.findSBs() and
dreamweaver.getParticipants() in the
Dreamweaver API Reference.
Arguments
None.
Returns
Dreamweaver expects an array of JavaScript objects; the length of the array is equal to the number
of behavior instances that are found in the page.