applyFormatDefinition()

Availability

Adobe 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

Adobe 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.