Commands.Item Method

  • Artikel

Returns the indexed Command object.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Function Item ( _
    index As Object, _
    ID As Integer _
) As Command

Command Item(
    Object index,
    int ID
)

Command^ Item(
    [InAttribute] Object^ index, 
    [InAttribute] int ID
)

abstract Item : 
        index:Object * 
        ID:int -> Command

function Item(
    index : Object, 
    ID : int
) : Command

Parameters

  • index
    Type: System.Object

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

  • ID
    Type: System.Int32

    Optional. The command ID in the specified command set.

Return Value

Type: EnvDTE.Command
A Command object.

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.

Examples

' Macro code.
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

.NET Framework Security

See Also

Reference

Commands Interface

EnvDTE Namespace