beautypg.com

Copyserverbehavior(), Deleteserverbehavior() – Adobe Extending Dreamweaver CS4 User Manual

Page 259

background image

253

EXTENDING DREAMWEAVER CS4

Server behaviors

Arguments
serverBehavior

The serverBehavior JavaScript object represents the behavior; it is necessary to modify an existing behavior. If this is a
new behavior, the argument is

null

.

Returns
Dreamweaver expects a Boolean value:

true

if the behavior can be applied;

false

otherwise.

copyServerBehavior()

Availability
Dreamweaver UltraDev 1.

Description
Implementing the

copyServerBehavior()

function is optional. Users can copy instances of the specified server

behavior. In the following example, this function is implemented for recordsets. If a user selects a recordset in the
Server Behaviors panel or the Data Bindings panel, using the Copy command copies the behavior to the Clipboard;
using the Cut command cuts the behavior to the Clipboard. For server behaviors that do not implement this function,
the Copy and Cut commands do nothing. For more information, see “

Scenarios in which the server behavior API

functions are called

” on page 249.

The

copyServerBehavior()

function should rely only on behavior object properties that can be converted into

strings to exchange information with the

pasteServerBehavior()

function. The Clipboard stores only raw text, so

participant

nodes in the document should be resolved and the resulting raw text should be saved into a secondary

property.

Note: The pasteServerBehavior() function must also be implemented to let the user paste the behavior into any
Dreamweaver document.

Arguments
serverBehavior

The serverBehavior JavaScript object represents the behavior.

Returns
Dreamweaver expects a Boolean value:

true

if the behavior copies successfully to the Clipboard;

false

otherwise.

deleteServerBehavior()

Availability
Dreamweaver UltraDev 1.

Description
Removes the behavior from the user’s document. It is called when the user clicks the Minus (-) button on the Server
Behaviors panel. It can edit a user’s document.

For more information, see “

dwscripts.deleteSB()

” on page 257.

This manual is related to the following products: