OutputWindowPane Interface

Represents a pane in the Output window.

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

Syntax

'Declaration
<GuidAttribute("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")> _
Public Interface OutputWindowPane
[GuidAttribute("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")]
public interface OutputWindowPane
[GuidAttribute(L"FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")]
public interface class OutputWindowPane
[<GuidAttribute("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")>]
type OutputWindowPane =  interface end
public interface OutputWindowPane

The OutputWindowPane type exposes the following members.

Properties

Name Description
Public property Collection Gets the collection containing the OutputWindowPane object supporting this property.
Public property DTE Gets the top-level extensibility object.
Public property Guid Gets the GUID for the OutputWindowPane object.
Public property Name Gets the name of the OutputWindowPane object.
Public property TextDocument Gets the TextDocument object for the OutputWindowPane .

Top

Methods

Name Description
Public method Activate Moves the focus to the current item.
Public method Clear Clears all text from the OutputWindowPane .
Public method ForceItemsToTaskList Sends all task items not yet added to the task list.
Public method OutputString Sends a text string to the OutputWindowPane window.
Public method OutputTaskItemString Displays a string in the Output window and adds a corresponding item to the Task List.

Top

Remarks

The Output window displays text output. The Output window can have one or more panes, represented by the OutputWindowPane object. Each IDE tool potentially uses a different output window pane. Panes are selected with a drop-down box at the top of the window. For example, build errors go to the Build Errors pane, while each external command tool potentially goes to its own distinct output window pane.

Examples

Sub OutputWindowPaneExample()
   ' Create a tool window handle for the Output window.
   Dim win As Window = DTE.Windows.Item(EnvDTE.Constants.vsWindowKindOutput)
   ' Create handles to the Output window and its panes.
   Dim OW As OutputWindow = win.Object
   Dim OWp As OutputWindowPane

   ' Add a new pane to the Output window.
   OWp = OW.OutputWindowPanes.Add("A New Pane")
   ' Add a line of text to the new pane.
   OWp.OutputString("Some Text")
End Sub

See Also

Reference

EnvDTE Namespace