Share via

MenuItem.Caption Property

  • Article
Visio Automation Reference

Gets or sets the caption for an object. Read/write.

Version Information
 Version Added:  Visio 4.0

Syntax

expression.Caption

expression   A variable that represents a MenuItem object.

Return Value
String

Remarks

Visio does not use the Caption property of a MenuSet or ToolbarSet object.

  • Use an ampersand (&) in the string to cause the next character in the string to become the shortcut key for that menu or menu item. For example, the string "F*&o*rmat" causes o to become the shortcut key for that menu item in that one menu.
  • Use "" in the string to display a double quotation mark on the menu.
  • Use && in the string to display an ampersand on the menu.

Example

The following Microsoft Visual Basic for Applications (VBA) macro shows how to use the Caption property. It adds a menu and menu item to the drawing window menu set and sets the menu and menu item's Caption properties.

To restore the built-in menus in Microsoft Office Visio after you run this macro, call the ThisDocument.ClearCustomMenus method.

Visual Basic for Applications 
  
Public Sub Caption_Example()
 
    Dim vsoUIObject As Visio.UIObject 
    Dim vsoMenuSets As Visio.MenuSets 
    Dim vsoMenuSet As Visio.MenuSet   
    Dim vsoMenus As Visio.Menus 
    Dim vsoMenu As Visio.Menu 
    Dim vsoMenuItems As Visio.MenuItems 
    Dim vsoMenuItem As Visio.MenuItem
 
    'Get a UIObject object that represents Microsoft Visio built-in menus.
    Set vsoUIObject = Visio.Application.BuiltInMenus 

'Get the MenuSets collection.
Set vsoMenuSets = vsoUIObject.MenuSets

'Get the drawing window menu set.
Set vsoMenuSet = vsoMenuSets.ItemAtID(visUIObjSetDrawing)

'Get the Menus collection.
Set vsoMenus = vsoMenuSet.Menus 

'Add a new menu before the Window menu.
Set vsoMenu = vsoMenus.AddAt(7) 
vsoMenu.Caption = "MyNewMenu" 

'Get the MenuItems collection.
Set vsoMenuItems = vsoMenu.MenuItems 

'Add a menu item to the new menu.
Set vsoMenuItem = vsoMenuItems.Add 

'Set the Caption property for the new menu item. 
vsoMenuItem.Caption = "&MyNewMenuItem" 

'Tell Visio to use the new UI when the document is active. 
ThisDocument.SetCustomMenus vsoUIObject 



End Sub

See Also