Commands2.Item(Object, Int32) Method

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Returns an indexed member of a collection.

EnvDTE::Command Item(winrt::Windows::Foundation::IInspectable const & index, int ID = -1);

[System.Runtime.InteropServices.DispId(0)]
public EnvDTE.Command Item (object index, int ID = -1);

[<System.Runtime.InteropServices.DispId(0)>]
abstract member Item : obj * int -> EnvDTE.Command

Public Function Item (index As Object, Optional ID As Integer = -1) As Command

Parameters

index

Object

Required. An absolute index, GUID string, or the command's full name.

ID

Int32

Optional. The command ID in the specified command set.

Returns

Command

A Command object.

Implements

Item(Object, Int32)

Attributes

DispIdAttribute

Examples

Sub ItemExample()  
   Dim cmds As Commands  
   Dim cmd As Command  

   ' Set references to the Commands collection and the File.NewFile   
   ' command.  
   cmds = DTE.Commands  
   cmd = cmds.Item("File.NewFile")  

   ' Assign the command (File.NewFile) globally to the F2 key.  
   ' Because you cannot programmatically change the default keyboard  
   ' mapping scheme settings, you must first make a copy of the Default   
   ' Settings for the Keyboard Mapping Scheme.  
   cmd.Bindings = "Global::f2"  
End Sub  

Remarks

If index is an absolute index (a Long), it is only meaningful for iterating over the commands from 1 to n. You cannot save a command's absolute index and use it later to access that command.

If index is a GUID string, then it indicates a command set and you must supply the ID argument to identify the command in the set.

If you supply the ID argument and the first argument is a string, then the indexargument must be a GUID string that identifies a command set. If index is a string and there is no ID argument, then index must be a command's full name. If index is a Long, then ID is ignored.