Freigeben über


Document-Schnittstelle

Stellt ein Dokument in der Umgebung dar, das zum Bearbeiten geöffnet ist.

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

Syntax

'Declaration
<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")> _
Public Interface Document
[GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface Document
[GuidAttribute(L"63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface class Document
[<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")>]
type Document =  interface end
public interface Document

Der Document-Typ macht die folgenden Member verfügbar.

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft ActiveWindow Ruft das derzeit aktive oder das oberste Fenster ab, wenn kein anderes Fenster aktiv ist.Gibt Nothing zurück, wenn keine Fenster geöffnet sind.
Öffentliche Eigenschaft Collection Ruft die Auflistung ab, die das Document-Objekt enthält.
Öffentliche Eigenschaft DTE Ruft das Erweiterbarkeitsobjekt der obersten Ebene ab.
Öffentliche Eigenschaft Extender Gibt den angeforderten Extender zurück, falls er für dieses Objekt verfügbar ist.
Öffentliche Eigenschaft ExtenderCATID Ruft die ID der Extenderkategorie (CATID) für das Objekt ab.
Öffentliche Eigenschaft ExtenderNames Ruft eine Liste der für das Objekt verfügbaren Extender ab.
Öffentliche Eigenschaft FullName Ruft den vollständigen Pfad und Namen der Objektdatei ab.
Öffentliche Eigenschaft IndentSize Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Eigenschaft Kind Ruft eine GUID-Zeichenfolge ab, die die Art bzw. den Typ des Objekts beschreibt.
Öffentliche Eigenschaft Language Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Eigenschaft Name Ruft den Namen der Document ab.
Öffentliche Eigenschaft Path Ruft den Pfad des Verzeichnisses, in dem das Dokument enthalten ist, ohne Dateinamen ab.
Öffentliche Eigenschaft ProjectItem Ruft das dem Document-Objekt zugeordnete ProjectItem-Objekt ab.
Öffentliche Eigenschaft ReadOnly Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Eigenschaft Saved Gibt true zurück, wenn das Objekt seit dem letzten Speichern oder Öffnen nicht geändert wurde.
Öffentliche Eigenschaft Selection Ruft ein Objekt ab, das die aktuelle Auswahl in Document darstellt.
Öffentliche Eigenschaft TabSize Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Eigenschaft Type Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Eigenschaft Windows Ruft eine Windows-Auflistung ab, die die im Objekt angezeigten Fenster enthält.

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode Activate Verschiebt den Fokus auf das aktuelle Element.
Öffentliche Methode ClearBookmarks Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Methode Close Schließt das geöffnete Dokument und speichert es optional oder schließt und zerstört das Fenster.
Öffentliche Methode MarkText Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Methode NewWindow Erstellt ein neues Fenster, in dem das Dokument angezeigt werden soll.
Öffentliche Methode Object Gibt eine Schnittstelle oder ein Objekt zurück, auf die/das zur Laufzeit über den Namen zugegriffen werden kann.
Öffentliche Methode PrintOut Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Methode Redo Führt die letzte Aktion, die durch die Undo-Methode oder den Benutzer rückgängig gemacht wurde, erneut aus.
Öffentliche Methode ReplaceText Infrastruktur. Nur für die interne Verwendung durch Microsoft vorgesehen.
Öffentliche Methode Save Speichert das Dokument.
Öffentliche Methode Undo Macht die letzte vom Benutzer im Dokument durchgeführte Aktion rückgängig.

Zum Seitenanfang

Hinweise

Ein Document-Objekt stellt alle geöffneten Dokumente oder Designer in der Umgebung dar – d. h. Fenster, die keine Toolfenster sind und einen Bereich zur Textbearbeitung aufweisen. Das Document-Objekt verfügt über Member (Eigenschaften, Methoden und Ereignisse), die zum Bearbeiten des Dokuments verwendet werden können. Wenn es sich um eine vom Visual Studio-Editor bearbeitete Textdatei handelt, ist dem Dokument zusätzlich ein TextDocument-Objekt zugeordnet.

Auf alle geöffneten Dokumente wird in der Documents-Auflistung verwiesen. Diese Auflistung kann durchlaufen werden, um ein bestimmtes Dokument zu finden.

Die Standardeigenschaft für ein Document-Objekt ist die Name-Eigenschaft.

Auf dieses Objekt können Sie mit DTE.Documents.Item(...) verweisen.

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

Siehe auch

Referenz

EnvDTE-Namespace