CommandWindow.TextDocument Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the TextDocument for the window or pane.

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

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

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

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

Public ReadOnly Property TextDocument As TextDocument

Property Value

TextDocument

A TextDocument object.

Attributes

DispIdAttribute

Examples

public void CodeExample(DTE2 dte, AddIn addin)  
{  
    try  
    {  
        // Get a reference to a Command window.  
        Window win = dte.Windows.Item(EnvDTE.Constants.vsWindowKindCommandWindow);  
        CommandWindow cmdWin = (CommandWindow)win.Object;  
        // Add some text to the window.  
        cmdWin.OutputString("This is a line of text in the CommandWindow TextDocument");  
        // Return the contents of the TextDocument and display them.  
        TextDocument txtDoc = cmdWin.TextDocument;  
        TextSelection txtSel = txtDoc.Selection;  
        TextRanges txtRanges = txtSel.TextRanges;  
        // Show text in textdocument.  
        foreach (TextRange txtRange in txtRanges)  
        {  
            txtRange.StartPoint.StartOfDocument();  
            MessageBox.Show(txtRange.StartPoint.GetText(txtRange.EndPoint));  
        }  
        // Show the CommandWindow's parent object's caption property.  
        MessageBox.Show("The Parent window's caption: " + cmdWin.Parent.Caption);  
        // Show the application object containing the CommandWindow.  
        MessageBox.Show(cmdWin.DTE.Name);  
    }  
    catch(Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

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