CommandWindow Interface

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the Command window in the environment.

public interface class CommandWindow

public interface class CommandWindow

__interface CommandWindow

[System.Runtime.InteropServices.Guid("509B9955-7303-48C9-90D4-E165B974E6BA")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface CommandWindow

[System.Runtime.InteropServices.Guid("509B9955-7303-48C9-90D4-E165B974E6BA")]
public interface CommandWindow

[<System.Runtime.InteropServices.Guid("509B9955-7303-48C9-90D4-E165B974E6BA")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type CommandWindow = interface

[<System.Runtime.InteropServices.Guid("509B9955-7303-48C9-90D4-E165B974E6BA")>]
type CommandWindow = interface

Public Interface CommandWindow

Attributes: GuidAttribute TypeLibTypeAttribute

Examples

Sub CommandWinExample(ByVal dte As DTE)  
    ' Get a reference to the Command window.  
    Dim win As Window = _  
    DTE.Windows.Item(EnvDTE.Constants.vsWindowKindCommandWindow)  
    Dim CW As CommandWindow = win.Object  

    ' Input a command into the Command window and execute it.  
    CW.SendInput("nav http://www.microsoft.com", False)  

    ' Insert some information text into the Command window.  
    CW.OutputString("This URL takes you to the main Microsoft _  
    website.")  

    ' Clear the contents of the Command window.  
    MsgBox("Clearing the Command window...")  
    CW.Clear()  
End Sub

void CommandWinExample(_DTE dte)   
{  
    // Get a reference to the Command window.  
    Window win =      
    dte.Windows.Item(EnvDTE.Constants.vsWindowKindCommandWindow);  
    CommandWindow CW = (CommandWindow)win.Object;  

    // Input a command into the Command window and execute it.  
    CW.SendInput("nav http://www.microsoft.com", false);  

    // Insert some information text into the Command window.  
    CW.OutputString("This URL takes you to the main Microsoft   
    website.");  

    // Clear the contents of the Command window.  
    MessageBox.Show("Clearing the Command window...");  
    CW.Clear();  
}

Remarks

Reference this object by using DTE.Windows.Item(vsWindowKindCommand).Object.

Properties

DTE	Gets the top-level extensibility object.
Parent	Gets the immediate parent object of a given object.
TextDocument	Gets the TextDocument for the window or pane.

Methods

Clear()	Clears all text from the window.
OutputString(String)	Sends a text string to the Command window.
SendInput(String, Boolean)	Sends a line of input to the Command window that is processed as if you typed it.

Applies to

Partilhar via