Document Schnittstelle

Definition

Stellt ein Dokument dar, das in der Umgebung zum Bearbeiten geöffnet ist.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
Attribute

Beispiele

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  

Hinweise

Ein- Document Objekt stellt jedes geöffnete Dokument oder den Designer in der Umgebung dar, d. –. Fenster, die keine Tool Fenster sind und über einen Bereich zum Bearbeiten von Text verfügen.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. Das- Document Objekt verfügt über Member (Eigenschaften, Methoden und Ereignisse), mit denen Sie das Dokument bearbeiten können.The Document object has members (properties, methods, and events) that you can use to manipulate the document. Handelt es sich um eine Textdatei, die vom Visual Studio-Editor bearbeitet wird, ist Ihr ebenfalls ein- TextDocument Objekt zugeordnet.If it is a text file edited by the Visual Studio editor, then it also has a TextDocument object associated with it.

In der Auflistung wird auf alle geöffneten Dokumente verwiesen Documents .All open documents are referenced in the Documents collection. Sie können ein bestimmtes Dokument suchen, indem Sie diese Auflistung durchlaufen.You can find a particular document by iterating through this collection.

Die Standard Eigenschaft für ein- Document Objekt ist die- Name Eigenschaft.The default property for a Document object is the Name property.

Verweisen Sie mit auf dieses Objekt DTE.Documents.Item(...) .Reference this object by using DTE.Documents.Item(...).

Eigenschaften

ActiveWindow

Ruft das derzeit aktive Fenster oder das oberste Fenster ab, wenn keine anderen aktiv sind.Gets the currently active window, or the topmost window if no others are active. Gibt Nothing zurück, wenn keine Fenster geöffnet sind.Returns Nothing if no windows are open.

Collection

Ruft die Auflistung ab, die das- Document Objekt enthält.Gets the collection containing the Document object.

DTE

Ruft das Erweiterbarkeitsobjekt der obersten Ebene ab.Gets the top-level extensibility object.

Extender[String]

Gibt den angeforderten Extender zurück, wenn dieser für dieses Objekt verfügbar ist.Returns the requested Extender if it is available for this object.

ExtenderCATID

Ruft die ID der Extenderkategorie (CATID) für das Objekt ab.Gets the Extender category ID (CATID) for the object.

ExtenderNames

Ruft eine Liste der für das Objekt verfügbaren Extender ab.Gets a list of available Extenders for the object.

FullName

Ruft den vollständigen Pfad und Namen der Objektdatei ab.Gets the full path and name of the object's file.

IndentSize

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Kind

Ruft eine GUID-Zeichenfolge ab, die die Art bzw. den Typ des Objekts beschreibt.Gets a GUID string indicating the kind or type of the object.

Language

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Name

Ruft den Namen von Document ab.Gets the name of the Document.

Path

Ruft den Pfad (ohne Dateiname) für das Verzeichnis ab, das das Dokument enthält.Gets the path, without file name, for the directory containing the document.

ProjectItem

Ruft das ProjectItem-Objekt ab, das dem Document-Objekt zugeordnet ist.Gets the ProjectItem object associated with the Document object.

ReadOnly

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Saved

Gibt zurück true , wenn das Objekt seit dem letzten Speichern oder öffnen nicht geändert wurde.Returns true if the object has not been modified since last being saved or opened.

Selection

Ruft ein Objekt ab, das die aktuelle Auswahl in der darstellt Document .Gets an object representing the current selection on the Document.

TabSize

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Type

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Windows

Ruft eine Windows-Auflistung ab, die die im Objekt angezeigten Fenster enthält.Gets a Windows collection containing the windows that display in the object.

Methoden

Activate()

Verschiebt den Fokus auf das aktuelle Element.Moves the focus to the current item.

ClearBookmarks()

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Close(vsSaveChanges)

Schließt das geöffnete Dokument, speichert es optional und zerstört das Fenster.Closes the open document and optionally saves it, or closes and destroys the window.

MarkText(String, Int32)

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

NewWindow()

Erstellt ein neues Fenster zum Anzeigen des Dokuments.Creates a new window in which to view the document.

Object(String)

Gibt eine Schnittstelle oder ein Objekt zurück, auf die zur Laufzeit über den Namen zugegriffen werden kann.Returns an interface or object that can be accessed at run time by name.

PrintOut()

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Redo()

Führt die letzte Aktion erneut aus, die von der- Undo() Methode oder dem Benutzer rückgängig gemacht wurde.Re-executes the last action that was undone by the Undo() method or the user.

ReplaceText(String, String, Int32)

Nur Microsoft-interne Verwendung.Microsoft Internal Use Only.

Save(String)

Speichert das Dokument.Saves the document.

Undo()

Kehrt die Aktion um, die zuletzt vom Benutzer im Dokument durchgeführt wurde.Reverses the action last performed by the user in the document.

Gilt für: