Adobe Extending Dreamweaver CS4 - Manual (Page 262)

256 EXTENDING DREAMWEAVER CS4
Server behaviors
Returns
Dreamweaver expects a Boolean value:
true if the behavior pastes successfully from the Clipboard; false otherwise.
Server behavior implementation functions
These functions can be added or edited within the HTML script files or the specified JavaScript files that are listed
within the HTML script file.
dwscripts.findSBs()
Availability
Dreamweaver MX (this function replaces the
findSBs() function from earlier versions of Dreamweaver).
Description
Finds all instances of a server behavior and all the participants on the current page. It sets the title, type, participants
array, weights array, types array,
selectedNode value, and incomplete flag. This function also creates a parameter
object that holds an array of user-definable properties such as recordset, name, and column name. You can return this
array from the
findServerBehaviors() function.
Arguments
serverBehaviorTitle
The serverBehaviorTitle argument is an optional title string that is used if no title is specified in the EDML title, which
is useful for localization.
Returns
Dreamweaver expects an array of JavaScript objects where the required properties are defined. Returns an empty array
if no instances of the server behavior appear on the page.
Example
The following example searches for all instances of a particular server behavior in the current user document:
function findServerBehaviors() {
allMySBs = dwscripts.findSBs();
return allMySBs;
}
dwscripts.applySB()
Availability
Dreamweaver MX (this function replaces the
applySB() function from earlier versions of Dreamweaver).
Description
Inserts or updates runtime code for the server behavior. If the sbObj argument has a
null value, it inserts new runtime
code; otherwise, it updates existing runtime code that is indicated by the sbObj object. User settings should be set as
properties on a JavaScript object and passed in as paramObj. These settings should match all the arguments that are
declared as
@@paramName@@ in the EDML insertion text.