beautypg.com

Displayhelp(), Findserverbehaviors() – Adobe Extending Dreamweaver CS4 User Manual

Page 260

background image

254

EXTENDING DREAMWEAVER CS4

Server behaviors

Arguments
serverBehavior

The serverBehavior JavaScript object represents the behavior.

Returns
Dreamweaver expects nothing.

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()

” on page 256 and

dreamweaver.getParticipants()

in the

Dreamweaver API Reference.

Arguments
None.

This manual is related to the following products: