Adobe 38040334 - Dreamweaver CS3 User Manual page 123

displayHelp()
Description
If you define this function, it displays a Help button below the OK and Cancel buttons in the Parameters dialog box.
This function is called when the user clicks the Help button.
Arguments
None.
Returns
Dreamweaver expects nothing.
Example
The following example opens the myObjectHelp.htm file in a browser; this file explains how to use the extension:
function displayHelp(){
var myHelpFile = dw.getConfigurationPath() +
'/ExtensionsHelp/myObjectHelp.htm';
dw.browseDocument(myHelpFile);
}
isDOMRequired()
Description
This function determines whether the object requires a valid DOM to operate. If this function returns a
or if the function is not defined, Dreamweaver assumes that the command requires a valid DOM and synchronizes
the Code and Design views for the document before executing. Synchronization causes all edits in the Code view to
be updated in the Design view.
Arguments
None.
Returns
Dreamweaver expects a
true
insertObject()
Availability
Dreamweaver MX.
Description
This function is required if the
inserts code into the user's document and closes the dialog box or displays an error message and leaves the dialog
box open. This works as an alternate function to use in objects instead of the
assume that the user is inserting text at the current insertion point and allows data validation when the user clicks
OK. You should use the
insertObject()
• You need to insert code in more than one place.
• You need to insert code somewhere other than the insertion point.
• You need to validate input before inserting code.
value if a command requires a valid DOM to operate;
function is not defined. It is called when the user clicks OK. It either
objectTag()
function if one of the following conditions exists:
DREAMWEAVER CS3
Extending Dreamweaver
otherwise.
false
function. It does not
objectTag()
117
value
true