Document.CustomToolbars Property

  • Article
Visio Automation Reference

Gets a UIObject object that represents the current custom toolbars and status bars of an Application object or a Document object. Read-only.

Version Information
 Version Added:  Visio 4.0

Syntax

expression.CustomToolbars

expression   A variable that represents a Document object.

Return Value
UIObject

Remarks

If Microsoft Office Visio toolbars and status bars have not been customized, either programmatically, by a Visio solution, or in the user interface, the CustomToolbars property returns Nothing.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to get the currently active user interface (UI) for your document without replacing the application-level custom UI. You must write additional code to add your custom UI items.

Visual Basic for Applications 
  Sub CustomToolbars_Example()

Dim vsoUIObject As Visio.UIObject

'Check whether there are custom toolbars bound to the document.
If ThisDocument.CustomToolbars Is Nothing Then

    'If not, check whether there are custom toolbars bound to the application.
    If Visio.Application.CustomToolbars Is Nothing Then

        'If not, use the Visio built-in toolbars.
        Set vsoUIObject = Visio.Application.BuiltInToolbars(0)
        MsgBox "Using Built-In Toolbars", 0

    Else

        'If there are existing Visio application-level custom toolbars, use them.
        Set vsoUIObject = Visio.Application.CustomToolbars
        MsgBox "Using Custom Toolbars", 0

    End If

Else

    'Use the existing custom toolbars.
    Set vsoUIObject = ThisDocument.CustomToolbars
    MsgBox "Using Custom Toolbars", 0

End If



End Sub

See Also