OutputWindowPane.Clear Method

Clears all text from the OutputWindowPane .

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

Syntax

'Declaration
Sub Clear

void Clear()

void Clear()

abstract Clear : unit -> unit 

function Clear()

Remarks

Clears all text from a single pane.

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();
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

OutputWindowPane Interface

EnvDTE Namespace

Other Resources

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