Document.SetCustomToolbars Method

  • Article
Visio Automation Reference

Replaces the current built-in or custom toolbars of an application or document.

Version Information
 Version Added:  Visio 4.0

Syntax

expression.SetCustomToolbars(ToolbarsObject)

expression   A variable that represents a Document object.

Parameters

Name Required/Optional Data Type Description
ToolbarsObject Required [IVUIOBJECT] An expression that returns a UIObject object that represents the new custom toolbars.

Return Value
Nothing

Remarks

If the ToolbarsObject object was created in a separate process by using the VBA CreateObject method instead of getting the appropriate property of an Application or Document object, the SetCustomToolbars method returns an error.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the SetCustomToolbars method to replace the built-in toolbar set with the custom set. It retrieves a copy of the built-in Visio toolbars, adds a toolbar button, sets the button icon, and then replaces the toolbar set.

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

Visual Basic for Applications 
  
Public Sub Set CustomToolbars_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 "<em>path\filename</em>" 

'Use the new custom UI. 
ThisDocument.SetCustomToolbars vsoUIObject 



End Sub

See Also