Menu functions

Menu functions handle optimizing and reloading the menus in Dreamweaver. The dreamweaver.getMenuNeedsUpdating() function and the dreamweaver.notifyMenuUpdated() function are designed specifically to prevent unnecessary update routines from running on the dynamic menus that are built into Dreamweaver. See dreamweaver.getMenuNeedsUpdating() and dreamweaver.notifyMenuUpdated() for more information.

dreamweaver.getMenuNeedsUpdating()

Availability

Dreamweaver 3.

Description

Checks whether the specified menu needs to be updated.

Arguments

 menuId 

• The menuId argument is a string that contains the value of the id attribute for the menu item, as specified in the menus.xml file.

Returns

A Boolean value that indicates whether the menu needs to be updated. This function returns false only if dreamweaver.notifyMenuUpdated() has been called with this menuId, and the return value of menuListFunction has not changed. For more information, see "dreamweaver.notifyMenuUpdated()" on page 686.

dreamweaver.notifyMenuUpdated()

Availability

Dreamweaver 3.

Description

Notifies Dreamweaver when the specified menu needs to be updated.

Arguments

 menuId, menuListFunction 

• The menuId argument is a string that contains the value of the id attribute for the menu item, as specified in the menus.xml file.

• The menuListFunction argument must be one of the following strings: "dw.cssStylePalette.getStyles()", "dw.getDocumentDOM().getFrameNames()", "dw.getDocumentDOM().getEditableRegionList", "dw.getBrowserList()", "dw.getRecentFileList()", "dw.getTranslatorList()", "dw.getFontList()", "dw.getDocumentList()", "dw.htmlStylePalette.getStyles()", or "site.getSites()".

Returns

Nothing.

dreamweaver.reloadMenus()

Availability

Dreamweaver 3.

Description

Reloads the entire menu structure from the menus.xml file in the Configuration folder.

Arguments

None.

Returns

Nothing.