UIObject.Clone Property

Visio Automation Reference

Returns a copy of the UIObject object. Read-only.

Version Information
 Version Added:  Visio 2000

Syntax

expression.Clone

expression   A variable that represents a UIObject object.

Return Value
UIObject

Remarks

Example

This example shows how to use the Clone property to make a copy of a UIObject object. The example adds a custom toolbar to the cloned toolbars collection. This toolbar appears in the Microsoft Office Visio user interface and is available while the document is active.

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

Visual Basic for Applications
  
Sub Clone_Example()
 
    Dim vsoUIObject As Visio.UIObject 
    Dim vsoToolbars As Visio.Toolbars 
    Dim vsoToolbar As Visio.Toolbar 
'Check whether there are document custom toolbars.
If ThisDocument.CustomToolbars Is Nothing Then

    'Check whether there are application custom toolbars.
    If Visio.Application.CustomToolbars Is Nothing Then

        'Use the built-in toolbars.
        Set vsoUIObject = Visio.Application.BuiltInToolbars(0) 

    Else

        'Use the application custom toolbars.
        Set vsoUIObject = Visio.Application.CustomToolbars.Clone

    End If


Else

    'Use the document custom toolbars.
    Set vsoUIObject = ThisDocument.CustomToolbars 

End If  

'Get the Toolbars collection for the drawing window context.
Set vsoToolbars = vsoUIObject.ToolbarSets.ItemAtID(Visio.visUIObjSetDrawing).Toolbars 

'Add a toolbar to the collection.
Set vsoToolbar = vsoToolbars.Add 

'Set the title of the toolbar. 
vsoToolbar.Caption = "My New Toolbar" 

'Tell Visio to use the new UIObject object while
'this document is active. 
ThisDocument.SetCustomToolbars vsoUIObject 

End Sub

See Also