Enabled Property [Visio 2003 SDK Documentation]

  • Article

Determines whether or not an object is currently enabled.

intVal = object**.Enabled**

object**.Enabled** = intExpression

intVal     Integer. False (0) if the object is disabled; True (-1) if it is enabled.

object     Required. An expression that returns an object in the Applies to list.

intExpression     Required Integer. False (0) to disable the object; True (non-zero) to enable the object.

Version added

4.0

Remarks

You can get and set the Enabled property of an Event object. An Event object that is disabled does not perform its action when its event occurs.

An add-on implemented by an executable (EXE) file always reports itself as enabled. An add-on implemented by a Visio Solutions Library (VSL) file reports itself as enabled or disabled according to the enabling policy that the VSL file has registered for that add-on.

You can't tell an add-on to enable or disable itself. Visio will not send a run message to a disabled add-on. The name of a disabled add-on on a Visio menu appears dimmed.

Example

This example shows how to use the Enabled property to enable hiding or showing a toolbar. The example adds a custom toolbar to the Toolbars collection. This toolbar appears in the Visio user interface and is available while the document is active.

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

Sub Enabled_Example() 

    Dim vsoUIObject As Visio.UIObject 
    Dim vsoToolbars As Visio.Toolbars 
    Dim vsoToolbar As Visio.Toolbar 
    Dim vsoToolbarItem As Visio.ToolbarItem 

    '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 = "Example"

    'Enable hiding or showing the toolbar. 
    vsoToolbar.Enabled = True 

    'Show the toolbar. 
    vsoToolbar.Visible = True 

    'Add an item to the toolbar.
    Set vsoToolbarItem = vsoToolbar.ToolbarItems.Add 
    With vsoToolbarItem 

        'Set the new item to be a button. 
        .CntrlType = Visio.visCtrlTypeBUTTON 

        'Set the icon of the new button. 
        .FaceID = Visio.visIconIXCUSTOM_CARDS 

        'Set the CmdNum property of the new button. 
        .CmdNum = 1 

        'Set the Width property of the new button
        'wide enough that the toolbar name is readable. 
        .Width = 100 

    End With 

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

Applies to | Addon object | Event object | Menu object | MenuItem object | MenuSet object | Toolbar object | ToolbarItem object