Menu.IconFileName method (Visio)
Sets a custom icon file for a menu or toolbar item.
Syntax
expression. IconFileName
( _IconFileName_
)
expression A variable that represents a Menu object.
Parameters
Name | Required/Optional | Data type | Description |
---|---|---|---|
IconFileName | Required | String | The path and name of the ICO, EXE, DLL, or VSL file to load. |
Return value
Nothing
Remarks
Note
Starting with Visio 2010, the Microsoft Office Fluent user interface (UI) replaced the previous system of layered menus, toolbars, and task panes. VBA objects and members that you used to customize the user interface in previous versions of Visio are still available in Visio, but they function differently.
The IconFileName method loads the file that contains the icon, saves the bits, and discards the file name.
If the icon contains multiple images, Microsoft Visio chooses the best icon, based on both icon size and color depth.
Unless IconFileName is a fully qualified path, the application searches for the ICO, EXE, DLL, or VSL file in the folders indicated by the Application object's AddonPaths property (assuming that the UIObject object is in the Visio process).
Example
This Microsoft Visual Basic for Applications (VBA) macro shows how to use the IconFileName method to set the icon for a toolbar button. It retrieves a copy of the built-in Visio toolbars, adds a toolbar button, and sets the button icon.
Before running this code, replace path \ filename with the full path to and name of a valid icon (.ico file) on your computer.
To restore the built-in Visio user interface after you run this macro, call the ThisDocument.ClearCustomToolbars method.
Public Sub IconFileName_Example()
Dim vsoUIObject As Visio.UIObject
Dim vsoToolbarSet As Visio.ToolbarSet
Dim vsoToolbarItems As Visio.ToolbarItems
Dim vsoToolbarItem As Visio.ToolbarItem
'Get the UIObject object for the copy of the built-in toolbars.
Set vsoUIObject = Visio.Application.BuiltInToolbars(0)
'Get the drawing window toolbar sets.
'NOTE: Use ItemAtID to get the toolbar set.
'Using vsoUIObject.ToolbarSets(visUIObjSetDrawing) will not work.
Set vsoToolbarSet = vsoUIObject.ToolbarSets.ItemAtID(visUIObjSetDrawing)
'Get the ToolbarItems collection.
Set vsoToolbarItems = vsoToolbarSet.Toolbars(0).ToolbarItems
'Add a new button in the first position.
Set vsoToolbarItem = vsoToolbarItems.AddAt(0)
'Set properties for the new toolbar button.
vsoToolbarItem.CntrlType = visCtrlTypeBUTTON
vsoToolbarItem.CmdNum = 1
vsoToolbarItem.IconFileName "path\filename "
'Use the new custom UI.
ThisDocument.SetCustomToolbars vsoUIObject
End Sub
Support and feedback
Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.