Applyformatdefinition(), Deleteformat() – Adobe Extending Dreamweaver CS4 User Manual
Page 312
306
EXTENDING DREAMWEAVER CS4
Server formats
The
applyFormat()
function should use the DOM to add function declarations to the top of the user’s document. For
example, if the user selects Currency - Default, the function adds the
Currency
function declaration.
Arguments
format
•
The format 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 nothing.
applyFormatDefinition()
Availability
Dreamweaver UltraDev 1.
Description
Commits the changes to a format that was created using the Edit Format dialog box.
Users can create, edit, or delete formats with the Edit Format List dialog box. This function is called to commit any
modifications that are made to a format. It can also set other, arbitrarily named properties on the object. Each property
is stored as an attribute of the
format
tag in the Formats.xml file.
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.