<function>

Description

Used in the CodeHints.xml file. This tag replaces the menu tag for specifying function arguments and object methods for a code hints pop-up menu. When you type a function or method name in Code view, Dreamweaver opens a menu of function prototypes, displaying the current argument in bold. Each time you type a comma, Dreamweaver updates the menu to display the next argument in bold. For example, if you typed the function name ArrayAppend in a ColdFusion document, the code hints menu would display ArrayAppend(array, value). After you type the comma following array, the menu updates to show ArrayAppend(array, value).

For object methods, when you type the object name, Dreamweaver opens a menu of the methods that are defined for that object.

The recognized functions are stored in the XML files in the Configuration/CodeHints folder.

Attributes

pattern, doctypes, casesensitive

• The pattern attribute specifies the name of the function and its argument list. For methods, the pattern attribute describes the name of the object, the name of the method, and the method’s arguments. For a function name, the code hints menu appears when the user types functionname(). The menu shows the list of arguments for the function. For an object method, the code hints menu appears when the user types objectname. (including the period). This menu shows the methods that have been specified for the object. After that, the code hints menu opens a list of the arguments for the method in the same way it does for a function.

• The doctypes attribute specifies that the menu is active only for the specified document types. This attribute lets you specify different lists of function names for ASP-JavaScript (ASP-JS), Java Server Pages (JSP), Macromedia ColdFusion, and so on. You can specify the doctypes attribute as a comma-separated list of document type IDs. For a list of Dreamweaver document types, see the Dreamweaver Configuration/Documenttypes/MMDocumentTypes.xml file.

• The casesensitive attribute specifies whether the pattern is case-sensitive. The possible values for the casesensitive attribute are true, false, or a subset of the comma-separated list that you specify for the doctypes attribute. The list of document types lets you specify that the pattern is case-sensitive for some document types but not for others. The value defaults to false if you omit this attribute. If the casesensitive attribute is a value of true, the code hints menu appears only if the text that the user types exactly matches the pattern that the pattern attribute specifies. If the casesensitive attribute is a value of false, the menu appears even if the pattern is lowercase and the text is uppercase.

Contents

None.

Container

The menugroup tag.

Example

// function example 
<function pattern="CreateDate(year, month, day)" DOCTYPES="ColdFusion" /> 
// object method example 
<function pattern="application.getAttribute(String name)" DOCTYPES="JSP" />