Home Library Learn Downloads Support Community
Sign in | United States - English | |
1 out of 1 rated this helpful - Rate this topic

TextDocument Interface

Visual Studio 2005

Represents a text file open in the editor, such as the Visual Studio Code editor.

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

C#
C++
VB
Copy 
[GuidAttribute("CB218890-1382-472B-9118-782700C88115")] 
public interface TextDocument
J#
Copy 
/** @attribute GuidAttribute("CB218890-1382-472B-9118-782700C88115") */ 
public interface TextDocument
JScript
Copy 
GuidAttribute("CB218890-1382-472B-9118-782700C88115") 
public interface TextDocument

The TextDocument object is based on the Visual C++ version 6.0 Document object.

In Visual C++ version 6.0, the properties and methods of the TextDocument object were a superset of the Document object. In Visual Studio, however, Document has all the methods and properties that were part of TextDocument in Visual C++ version 6.0. In Visual Studio, TextDocument has only text-specific methods. The reason this does not break old code is that all methods that returned a TextDocument object in Visual C++ version 6.0 now return a Document object. So, old code that expects a TextDocument object actually uses a Document object.

VB
Copy 
Sub TextDocExample(ByVal dte As EnvDTE.DTE)
    Dim objTD As TextDocument = dte.ActiveDocument.Object
    MsgBox("Selection: " & objTD.Selection.Mode.ToString)
End Sub

public void TextDocExample(_DTE dte)
{
    TextDocument td = (TextDocument)dte.ActiveDocument.Object ("");
    MessageBox.Show ("Selection: " + td.Selection.Mode.ToString ());
}
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Example shows both C# and Visual Basic
The example above is headlined Visual Basic, meaning that the language used for the example is Visual Basic. However, this example also includes C# code.
History
Example should be more specific for an object type
The example in this topic uses ActiveDocument.Object("") to find the text document. While this will work if the window is a text document, the more correct way would be to use the code ActiveDocument.Object("TextDocument"), since a document could have more than one object type associated with it.
History
Advertisement