Command.IsAvailable Property

  • Reference

Definition

Namespace:
EnvDTE
Assembly:
EnvDTE.dll
Assembly:
Microsoft.VisualStudio.Interop.dll

Gets a value indicating whether or not the Command is currently enabled.

public:
 property bool IsAvailable { bool get(); };
public:
 property bool IsAvailable { bool get(); };
[System.Runtime.InteropServices.DispId(6)]
public bool IsAvailable { [System.Runtime.InteropServices.DispId(6)] get; }
[<System.Runtime.InteropServices.DispId(6)>]
[<get: System.Runtime.InteropServices.DispId(6)>]
member this.IsAvailable : bool
Public ReadOnly Property IsAvailable As Boolean

Property Value

Boolean

A Boolean value indicating true if the command is currently enabled; otherwise, false.

Attributes
DispIdAttribute

Examples

Sub IsAvailableExample()  
   ' Before running, you must add a reference to  
   ' Microsoft.VisualStudio.CommandBars.  
   Dim cmds As Commands  
   Dim cmdobj As Command  
   Dim customin, customout As Object  
   Dim colAddins As AddIns  

   ' Set references.  
   colAddins = DTE.AddIns()  
   cmds = DTE.Commands  
   cmdobj = cmds.Item("File.NewFile")  

   ' List some of the command properties.  
   MsgBox("Command Name: " & cmdobj.Name)  
   MsgBox("Is Command Available?: " & cmdobj.IsAvailable)  
   MsgBox("Command ID: " & cmdobj.ID)  
   MsgBox("Command GUID: " & cmdobj.Guid)  
End Sub

Applies to