Share via

BuiltInToolbars Property [Visio 2003 SDK Documentation]

  • Article

Returns a UIObject object that represents a copy of the built-in Microsoft Office Visio toolbars.

objRet = object**.BuiltInToolbars**(fIgnored)

objRet     A UIObject object that represents the built-in Visio toolbars.

object     Required. An expression that returns an Application object.

fIgnored     Required Integer. Required for backward compatibility, but ignored. It is suggested that you pass zero (0).

Version added

4.0

Remarks

You can use the BuiltInToolbars property to obtain a UIObject object and modify its toolbars. You can then use the SetCustomToolbars method of an Application or Document object to substitute your customized toolbars for the built-in Visio toolbars.

You can also use the SaveToFile method of the UIObject object to store its toolbars in a file and reload them as custom toolbars by setting the CustomToolbarsFile property of an Application or Document object.

Prior to Visio 5.0, the argument for this property was (fWhichToolbars), which designated the type of toolbar to get (MSOffice or LotusSS). Beginning with Visio 5.0, the application no longer supports different types of toolbars and the current argument, (fIgnored), is ignored.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the BuiltInToolbars property to get a copy of the built-in Visio toolbars, add a toolbar button, set the button icon, and replace the built-in toolbar set with the custom set.

Before running this macro, replace (path\filename) in the code below with the full path to and file name of an icon file (.ico) on your computer.

To restore the built in Visio toolbars after you run this macro, call the ThisDocument.ClearCustomToolbars method.

Public Sub BuiltInToolbars_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 sets.
    '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 

    'Set the caption for the new toolbar button.
    vsoToolbarItem.Caption = "MyButton"

    'Set the icon for the new toolbar button. 
    vsoToolbarItem.IconFileName "(path\filename)"

    'Tell Visio to actually use the new custom UI. 
    ThisDocument.SetCustomToolbars vsoUIObject 

End Sub

Applies to | Application object | InvisibleApp object

See Also | BuiltInMenus property | CustomToolbarsFile property | SaveToFile method | SetCustomToolbars method | UIObject object