Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
OutputWindowPane Interface
Collapse the table of content
Expand the table of content

OutputWindowPane Interface

Represents a pane in the Output window.

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

'Declaration
<GuidAttribute("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")> _
Public Interface OutputWindowPane

The OutputWindowPane type exposes the following members.

  NameDescription
Public propertyCollectionGets the collection containing the OutputWindowPane object supporting this property.
Public propertyDTEGets the top-level extensibility object.
Public propertyGuidGets the GUID for the OutputWindowPane object.
Public propertyNameGets the name of the OutputWindowPane object.
Public propertyTextDocumentGets the TextDocument object for the OutputWindowPane .
Top

  NameDescription
Public methodActivateMoves the focus to the current item.
Public methodClearClears all text from the OutputWindowPane .
Public methodForceItemsToTaskListSends all task items not yet added to the task list.
Public methodOutputStringSends a text string to the OutputWindowPane window.
Public methodOutputTaskItemStringDisplays a string in the Output window and adds a corresponding item to the Task List.
Top

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.

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
Show:
© 2015 Microsoft