MacroDesc$()

Syntax

MacroDesc$(Name$)

Remarks

Returns the description associated with the macro Name$. The same text is displayed in the Description box when you select the macro in the Macro dialog box (Tools menu) and in the status bar when you select a macro assigned to a menu or toolbar. You can set macro descriptions with ToolsMacro.

If Name$ does not exist in the active template or the Normal template, an error occurs. If Name$ exists in both the active template and the Normal template, the description for the macro in the active template is returned.

Example

This example prints a list of macros in the Normal template and their descriptions. To print a similar list for the active template, substitute CountMacros(1) and MacroName$(count, 1) in the first and second instructions, respectively.

For count = 1 To CountMacros(0)
    name$ = MacroName$(count, 0)
    Bold 1
    Insert name$ + Chr$(9)
    Bold 0
    Insert MacroDesc$(name$)
    InsertPara
Next count

See Also

CountMacros(), KeyMacro$(), MacroName$(), MenuItemMacro$(), ToolsMacro