TextDocument Interface

Represents a text file open in the editor.

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

Syntax

'Declaration
<GuidAttribute("CB218890-1382-472B-9118-782700C88115")> _
Public Interface TextDocument

[GuidAttribute("CB218890-1382-472B-9118-782700C88115")]
public interface TextDocument

[GuidAttribute(L"CB218890-1382-472B-9118-782700C88115")]
public interface class TextDocument

[<GuidAttribute("CB218890-1382-472B-9118-782700C88115")>]
type TextDocument =  interface end

public interface TextDocument

The TextDocument type exposes the following members.

Properties

	Name	Description
	DTE	Gets the top-level extensibility object.
	EndPoint	Gets a TextPoint object that is the location of the end of the document.
	IndentSize	Infrastructure. Microsoft Internal Use Only.
	Language	Infrastructure. Microsoft Internal Use Only.
	Parent	Gets the immediate parent object of a TextDocument object.
	Selection	Gets an object representing the current selection on the TextDocument object.
	StartPoint	Gets the TextPoint object representing the beginning of the text document, or the first displayed character of the pane.
	TabSize	Infrastructure. Microsoft Internal Use Only.
	Type	Infrastructure. Microsoft Internal Use Only.

Top

Methods

	Name	Description
	ClearBookmarks	Removes all unnamed bookmarks in the text document.
	CreateEditPoint	Creates an EditPoint object at the specified location and returns it. The default location is the beginning of the document.
	MarkText	Indicates whether or not the indicated text was found in the text document and creates unnamed bookmarks wherever matching text is found.
	PrintOut	Infrastructure. Microsoft Internal Use Only.
	ReplacePattern	Replaces matching text throughout an entire text document.
	ReplaceText	Infrastructure. Microsoft Internal Use Only.

Top

Remarks

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.

Examples

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 ());
}

See Also

Reference

EnvDTE Namespace