User Guide

The Server Formats API 311
Arguments
format
• The format argument corresponds to the JavaScript format object. The function must set the
expression property of the JavaScript object to be the regular expression for the format. The
function can also set other, arbitrarily named properties of the object. Each property is stored
as an attribute of the
format tag.
Returns
Dreamweaver expects the format object, if the function completes successfully. If an error occurs,
the function returns an error string. If it returns an empty string, the form is closed, but the new
format is not created, which is the same as a Cancel operation.
deleteFormat()
Availability
Dreamweaver UltraDev 1.
Description
Removes the format function declaration from the top of the user’s document.
When the user changes the format of a dynamic data object (in the Dynamic Data or the
Dynamic Text dialog box or in the Bindings panel) or deletes a formatted dynamic data object,
Dreamweaver removes the function declaration from the top of the document and also removes
the function call from the dynamic data object by calling the
deleteFormat() function.
Use the DOM with the
deleteFormat() function to remove the function declaration from the
top of the current document.
Arguments
format
• The format argument is a JavaScript object that describes the format to remove. The
JavaScript object is the node that corresponds to the
format tag in the Formats.xml file.
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.