OutputWindowPane.TextDocument Property

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.

Gets the TextDocument object for the OutputWindowPane .

public:
 property EnvDTE::TextDocument ^ TextDocument { EnvDTE::TextDocument ^ get(); };

public:
 property EnvDTE::TextDocument ^ TextDocument { EnvDTE::TextDocument ^ get(); };

[System.Runtime.InteropServices.DispId(10)]
public EnvDTE.TextDocument TextDocument { [System.Runtime.InteropServices.DispId(10)] get; }

[<System.Runtime.InteropServices.DispId(10)>]
[<get: System.Runtime.InteropServices.DispId(10)>]
member this.TextDocument : EnvDTE.TextDocument

Public ReadOnly Property TextDocument As TextDocument

Property Value

TextDocument

A TextDocument object.

Attributes: DispIdAttribute

Examples

Sub TextDocumentExample(ByVal dte As DTE2)  

    ' Retrieve and show the Output window.  
    Dim outWin As OutputWindow = dte.ToolWindows.OutputWindow  
    outWin.Parent.AutoHides = False  
    outWin.Parent.Activate()  

    ' Find the "Pane1" Output window pane; if it does not exist,   
    ' create it.  
    Dim pane1 As OutputWindowPane  
    Try  
        pane1 = outWin.OutputWindowPanes.Item("Pane1")  
    Catch  
        pane1 = outWin.OutputWindowPanes.Add("Pane1")  
    Finally  
        pane1.Clear()  
    End Try  

    ' Write 10 lines of text to Pane1.  
    Dim i As Integer  
    For i = 1 To 10  
        pane1.OutputString("Line " & i.ToString() & vbCrLf)  
    Next  

    ' Retrieve the text from Pane1.  
    Dim doc As TextDocument = pane1.TextDocument  
    Dim sel As TextSelection = doc.Selection  

    sel.StartOfDocument()  
    sel.EndOfDocument(True)  

    MsgBox("Text in Pane1:" & vbCrLf & vbCrLf & sel.Text)  

End Sub

public void TextDocumentExample(DTE2 dte)  
{  
    // Retrieve and show the Output window.  
    OutputWindow outWin = dte.ToolWindows.OutputWindow;  
    outWin.Parent.AutoHides = false;  
    outWin.Parent.Activate();  

    // Find the "Pane1" Output window pane; if it does not exist,   
    // create it.  
    OutputWindowPane pane1 = null;  
    try  
    {  
        pane1 = outWin.OutputWindowPanes.Item("Pane1");  
    }  
    catch  
    {  
        pane1 = outWin.OutputWindowPanes.Add("Pane1");  
    }  
    finally  
    {  
        pane1.Clear();  
    }  

    // Write 10 lines of text to Pane1.  
    for (int i = 1; i <= 10; i++)  
        pane1.OutputString("Line " + i.ToString() + "\n");  

    // Retrieve the text from Pane1.  
    TextDocument doc = pane1.TextDocument;  
    TextSelection sel = doc.Selection;  

    sel.StartOfDocument(false);  
    sel.EndOfDocument(true);  

    MessageBox.Show("Text in Pane1:\n\n" + sel.Text);  
}

Remarks

Attempting to modify the document through this property or an EditPoint fails because the entire document's region is read-only. You can modify the document only through members on CommandWindow.

Applies to

Share via