OutputWindowPane Interface

 

Represents a pane in the Output window.

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

[GuidAttribute("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")]
public interface OutputWindowPane

NameDescription
System_CAPS_pubpropertyCollection

Gets the collection containing the OutputWindowPane object supporting this property.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyGuid

Gets the GUID for the OutputWindowPane object.

System_CAPS_pubpropertyName

Gets the name of the OutputWindowPane object.

System_CAPS_pubpropertyTextDocument

Gets the TextDocument object for the OutputWindowPane .

NameDescription
System_CAPS_pubmethodActivate()

Moves the focus to the current item.

System_CAPS_pubmethodClear()

Clears all text from the OutputWindowPane .

System_CAPS_pubmethodForceItemsToTaskList()

Sends all task items not yet added to the task list.

System_CAPS_pubmethodOutputString(String)

Sends a text string to the OutputWindowPane window.

System_CAPS_pubmethodOutputTaskItemString(String, vsTaskPriority, String, vsTaskIcon, String, Int32, String, Boolean)

Displays a string in the Output window and adds a corresponding item to the Task List.

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
Return to top
Show: