Command.ID Property

  • Article

Gets the ID within a command group GUID used to represent the command.

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

Syntax

'Declaration
ReadOnly Property ID As Integer

int ID { get; }

property int ID {
    int get ();
}

abstract ID : int with get

function get ID () : int

Property Value

Type: System.Int32
An integer representing the command ID.

Examples

Sub IDExample(ByVal dte As DTE2)

    ' Create a new text document.
    Dim win As Window = dte.ItemOperations.NewFile()
    Dim textWin As TextWindow = CType(win.Object, TextWindow)

    ' Split the text document window.
    Dim cmd As Command = dte.Commands.Item("Window.Split")
    dte.Commands.Raise(cmd.Guid, cmd.ID, Nothing, Nothing)

    If MsgBox("Activate the top pane?", MsgBoxStyle.YesNo) = _
        MsgBoxResult.Yes Then

        ' In a split window, the top pane is always at index 2 of the 
        ' Panes collection.
        textWin.Panes.Item(2).Activate()
    Else
        textWin.Panes.Item(1).Activate()
    End If

End Sub

public void IDExample(DTE2 dte)
{
    // Create a new text document.
    Window win = dte.ItemOperations.NewFile(@"General\Text File", "", 
        Constants.vsViewKindPrimary);
    TextWindow textWin = (TextWindow)win.Object;

    // Split the text document window.
    Command cmd = dte.Commands.Item("Window.Split", -1);
    object dummy = new object();
    dte.Commands.Raise(cmd.Guid, cmd.ID, ref dummy, ref dummy);

    if (MessageBox.Show("Activate the top pane?", "", 
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        // In a split window, the top pane is always at index 2 of the 
        // Panes collection.
        textWin.Panes.Item(2).Activate();
    }
    else
    {
        textWin.Panes.Item(1).Activate();
    }
}

.NET Framework Security

See Also

Reference

Command Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples