Document Interface

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.

Represents a document in the environment open for editing.

public interface class Document

public interface class Document

__interface Document

[System.Runtime.InteropServices.Guid("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Document

[<System.Runtime.InteropServices.Guid("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Document = interface

Public Interface Document

Attributes: GuidAttribute TypeLibTypeAttribute

Examples

Sub DocumentExample()  
    Dim doc As Document  
    Dim desc As String  

    Set doc = DTE.ActiveDocument  
    desc = "You are editing a "  
    If (doc.ReadOnly) Then  
        desc = desc & "read-only"  
    Else  
        desc = desc & "writable"  
    End If  
    desc = desc & " document called " & doc.Name & " located at " & doc.Path  
    MsgBox desc  
End Sub

Remarks

A Document object represents each open document or designer in the environment — that is, windows that are not tool windows and have an area to edit text. The Document object has members (properties, methods, and events) that you can use to manipulate the document. If it is a text file edited by the Visual Studio editor, then it also has a TextDocument object associated with it.

All open documents are referenced in the Documents collection. You can find a particular document by iterating through this collection.

The default property for a Document object is the Name property.

Reference this object by using DTE.Documents.Item(...).

Properties

ActiveWindow	Gets the currently active window, or the topmost window if no others are active. Returns `Nothing` if no windows are open.
Collection	Gets the collection containing the Document object.
DTE	Gets the top-level extensibility object.
Extender[String]	Returns the requested Extender if it is available for this object.
ExtenderCATID	Gets the Extender category ID (CATID) for the object.
ExtenderNames	Gets a list of available Extenders for the object.
FullName	Gets the full path and name of the object's file.
IndentSize	Microsoft Internal Use Only.
Kind	Gets a GUID string indicating the kind or type of the object.
Language	Microsoft Internal Use Only.
Name	Gets the name of the Document.
Path	Gets the path, without file name, for the directory containing the document.
ProjectItem	Gets the ProjectItem object associated with the Document object.
ReadOnly	Microsoft Internal Use Only.
Saved	Returns `true` if the object has not been modified since last being saved or opened.
Selection	Gets an object representing the current selection on the Document.
TabSize	Microsoft Internal Use Only.
Type	Microsoft Internal Use Only.
Windows	Gets a Windows collection containing the windows that display in the object.

Methods

Activate()	Moves the focus to the current item.
ClearBookmarks()	Microsoft Internal Use Only.
Close(vsSaveChanges)	Closes the open document and optionally saves it, or closes and destroys the window.
MarkText(String, Int32)	Microsoft Internal Use Only.
NewWindow()	Creates a new window in which to view the document.
Object(String)	Returns an interface or object that can be accessed at run time by name.
PrintOut()	Microsoft Internal Use Only.
Redo()	Re-executes the last action that was undone by the Undo() method or the user.
ReplaceText(String, String, Int32)	Microsoft Internal Use Only.
Save(String)	Saves the document.
Undo()	Reverses the action last performed by the user in the document.

Applies to

Share via