IconFileName Method [Visio 2003 SDK Documentation]

  • Article

Sets a custom icon file for a menu or toolbar item.

object**.IconFileName**(IconFileName)

object     Required. An expression that returns a Menu, MenuItem, or ToolbarItem that loads the icon file.

IconFileName     Required String. The path and name of the ICO, EXE, DLL, or VSL file to load.

Version added

4.0

Remarks

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 Office 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 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 toolbars 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 

    'Set the toolbar button icon. 
    vsoToolbarItem.IconFileName "path\filename" 

    'Use the new custom UI. 
    ThisDocument.SetCustomToolbars vsoUIObject 

End Sub

Applies to | Menu object | MenuItem object | ToolbarItem object

See Also | AddonPaths property