Macromedia dreamweaver 8-extending dreamweaver User Manual

The Server Formats API

405

Returns

Dreamweaver expects nothing.

formatDynamicDataRef()

Availability

Dreamweaver UltraDev 1.

Description

Adds the format function call to the dynamic data object. When a user selects a format from 
the Format text box in the Dynamic Data or the Dynamic Text dialog box or in the Bindings 
panel, Dreamweaver makes two changes to the user’s document: It adds the appropriate 
format function before the HTML tag (if it’s not already there), and it changes the dynamic 
data object to call the appropriate format function.

Dreamweaver adds the function declaration by calling the 

applyFormat()

 JavaScript 

function in the data format file. It changes the dynamic data object by calling the 

formatDynamicDataRef()

 function.

The 

formatDynamicDataRef()

 function is called when the user selects a format from the 

Format text box in the Dynamic Data or the Dynamic Text dialog box or in the Bindings 
panel. It does not edit the user’s document.

Arguments

, 

■

The 

 argument is a string that contains the dynamic data object.

■

The 

 argument is a JavaScript object that describes the format to apply. The 

JavaScript object is the node that corresponds to the 

format

 tag in the Formats.xml file. 

The object has a JavaScript property for each attribute of the corresponding 

format

 tag.

Returns

Dreamweaver expects the new value for the dynamic data object.

If an error occurs, the function displays an alert message under certain conditions. If the 
function returns an empty string, the Format text box is set to 

None

.