OutputWindowPane.Clear Method

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Clears all text from the OutputWindowPane .

public:
 void Clear();

public:
 void Clear();

void Clear();

[System.Runtime.InteropServices.DispId(8)]
public void Clear ();

[<System.Runtime.InteropServices.DispId(8)>]
abstract member Clear : unit -> unit

Public Sub Clear ()

Attributes

DispIdAttribute

Examples

Sub ClearExample(ByVal dte As DTE2)  

    ' Retrieve the Output window.  
    Dim outputWin As OutputWindow = dte.ToolWindows.OutputWindow  

    ' Find the "Test Pane" Output window pane; if it does not exist,   
    ' create it.  
    Dim pane As OutputWindowPane  
    Try  
        pane = outputWin.OutputWindowPanes.Item("Test Pane")  
    Catch  
        pane = outputWin.OutputWindowPanes.Add("Test Pane")  
    End Try  

    ' Show the Output window and activate the new pane.  
    outputWin.Parent.AutoHides = False  
    outputWin.Parent.Activate()  
    pane.Activate()  

    ' Add a line of text to the new pane.  
    pane.OutputString("Some text." & vbCrLf)  

    If MsgBox("Clear the Output window pane?", MsgBoxStyle.YesNo) = _  
        MsgBoxResult.Yes Then  
        pane.Clear()  
    End If  

End Sub  

public void ClearExample(DTE2 dte)  
{  
    // Retrieve the Output window.  
    OutputWindow outputWin = dte.ToolWindows.OutputWindow;  

    // Find the "Test Pane" Output window pane; if it doesn't exist,   
    // create it.  
    OutputWindowPane pane = null;  
    try  
    {  
        pane = outputWin.OutputWindowPanes.Item("Test Pane");  
    }  
    catch  
    {  
        pane = outputWin.OutputWindowPanes.Add("Test Pane");  
    }  

    // Show the Output window and activate the new pane.  
    outputWin.Parent.AutoHides = false;  
    outputWin.Parent.Activate();  
    pane.Activate();  

    // Add a line of text to the new pane.  
    pane.OutputString("Some text." + "\r\n");  

    if (MessageBox.Show("Clear the Output window pane?", "",   
        MessageBoxButtons.YesNo) == DialogResult.Yes)  
        pane.Clear();  
}  

Remarks

Clears all text from a single pane.