TextDocument Object

  • Article

Home Page (Objects) |  Overview |  FAQ |  Reference

The TextDocument object represents an open text file.

The TextDocument object has the following properties and methods:

Properties
Active Path
ActiveWindow ReadOnly
Application Saved
FullName Selection
IndentSize TabSize
Language Type
Name Windows
Parent
Methods
Close Redo
ClearBookmarks ReplaceText
MarkText Save
NewWindow Undo
PrintOut

You can access all TextDocument objects by using the Documents property of the Application object.

You cannot access properties of the TextEditor object through a TextDocument object.

Using a Dual Interface to Access This Object

This section about dual interfaces is useful for writing add-ins or automating Developer Studio across processes. This section is not applicable to writing VBScript macros.

The Project object implements the ITextDocument dual interface. Through this interface, add-ins can directly access the members (properties, methods, and events) of this object and can employ early binding to make calls into these members faster at run time.

Add-ins written in Visual C++ can access members of the TextDocument object by using the header files in Vc98\Include\objmodel. However, if you use the Developer Studio Add-in Wizard to create an add-in, the wizard automatically includes these header files in your source code.

The following table shows the header files you need for the TextDocument object:

Header file Description
textauto.h Declares the dual interfaces.
textguid.h Declares the GUIDs used to identify the interfaces.
textdefs.h Declares additional information needed to use the interfaces, such as error IDs and enumerated constants.

Add-ins written in Visual Basic can access members of the TextDocument object by using the Visual Studio '97 Text Editor type library, located in Msdev98\bin\devedit.pkg.

Note   Visual Studio '97 Text Editor is the name that appears in the Visual Basic References dialog box.

See Also   Document object, Documents object.