OutputWindowPane Interface

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a pane in the Output window.

public interface class OutputWindowPane

public interface class OutputWindowPane

__interface OutputWindowPane

[System.Runtime.InteropServices.Guid("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface OutputWindowPane

[System.Runtime.InteropServices.Guid("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")]
public interface OutputWindowPane

[<System.Runtime.InteropServices.Guid("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type OutputWindowPane = interface

[<System.Runtime.InteropServices.Guid("FFC9DFC4-61CA-4B0C-83C2-0703A24F5C16")>]
type OutputWindowPane = interface

Public Interface OutputWindowPane

Attributes: GuidAttribute TypeLibTypeAttribute

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

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.

Properties

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

Methods

Activate()	Moves the focus to the current item.
Clear()	Clears all text from the OutputWindowPane .
ForceItemsToTaskList()	Sends all task items not yet added to the task list.
OutputString(String)	Sends a text string to the OutputWindowPane window.
OutputTaskItemString(String, vsTaskPriority, String, vsTaskIcon, String, Int32, String, Boolean)	Displays a string in the Output window and adds a corresponding item to the Task List.

Applies to

Share via