DocumentExtensions.GetVstoObject-Methode (2007 System)

Článek
08/23/2008

Aktualisiert: November 2007

Gibt ein Hostelement des Dokuments zurück, das die Funktionalität eines systemeigenen Word-Dokuments erweitert.

Namespace: Microsoft.Office.Tools.Word.Extensions
Assembly: Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function GetVstoObject ( _
    document As _Document _
) As Document
'Usage
Dim document As _Document
Dim returnValue As Document

returnValue = document.GetVstoObject()

public static Document GetVstoObject(
    this _Document document
)

Parameter

document
Typ: Microsoft.Office.Interop.Word._Document

Rückgabewert

Typ: Microsoft.Office.Tools.Word.Document

Ein Visual Studio Tools for Office-Hostelement für ein Word-Dokument.

Hinweis zur Verwendung

In Visual Basic und C# können Sie diese Methode als Instanzenmethode für ein beliebiges Objekt vom Typ _Document aufrufen. Bei Verwendung der Syntax für Instanzenmethoden lassen Sie den ersten Parameter aus. Weitere Informationen finden Sie unter Erweiterungsmethoden (Visual Basic) und Erweiterungsmethoden (C#-Programmierhandbuch).

Hinweise

Rufen Sie diese Methode in einem Add-In auf Anwendungsebene auf, um ein beliebiges, in Word geöffnetes Dokument anzupassen. Diese Methode gibt ein Microsoft.Office.Tools.Word.Document-Hostelement zurück.

Diese Methode generiert ein neues Microsoft.Office.Tools.Word.Document-Objekt, falls ein solches Objekt nicht bereits generiert wurde. Nachfolgende Aufrufe dieser Methode geben die zwischengespeicherte Instanz des vorhandenen Microsoft.Office.Tools.Word.Document-Objekts zurück.

Hinweis:
Der document-Parameter ist vom Typ Microsoft.Office.Interop.Word._Document, bei dem es sich um die übergeordnete Schnittstelle von Microsoft.Office.Interop.Word.Document handelt. Deshalb erweitert diese Methode beide Typen: Microsoft.Office.Interop.Word._Document und Microsoft.Office.Interop.Word.Document. Normalerweise wird mithilfe von Microsoft.Office.Interop.Word.Document auf ein Word-Dokument verwiesen.

Der document-Parameter ist vom Typ Microsoft.Office.Interop.Word._Document, bei dem es sich um die übergeordnete Schnittstelle von Microsoft.Office.Interop.Word.Document handelt. Deshalb erweitert diese Methode beide Typen: Microsoft.Office.Interop.Word._Document und Microsoft.Office.Interop.Word.Document. Normalerweise wird mithilfe von Microsoft.Office.Interop.Word.Document auf ein Word-Dokument verwiesen.

Einschränkungen bei Anpassungen auf Dokumentebene

In einem Projekt mit einer Anpassung auf Dokumentebene kann diese Methode nicht so umfassend angewendet werden wie in einem Add-In auf Anwendungsebene. Sie können sie nicht dazu verwenden, ein neues Visual Studio Tools for Office-Word-Dokument für ein systemeigenes Word-Dokument zu generieren. Mit dieser Methode können Sie ein vorhandenes Visual Studio Tools for Office-Word-Dokument abrufen, das zur Entwurfszeit Bestandteil des Anpassungsprojekts war. Weitere Informationen hierzu finden Sie unter Abrufen von erweiterten Objekten aus systemeigenen Office-Objekten in Anpassungen auf Dokumentebene.

Wenn dem Visual Studio Tools for Office-Word-Dokument kein systemeigenes Word-Dokument zugrunde liegt, gibt diese Methode nullNULL-Verweis (Nothing in Visual Basic) zurück.

Beispiele

Das folgende Codebeispiel ruft das Visual Studio Tools for OfficeMicrosoft.Office.Tools.Word.Document-Objekt aus dem aktiven Word-Dokument ab. Im Beispiel wird dem Dokument dann ein Nur-Text-Inhaltssteuerelement hinzugefügt. Wenn Sie dieses Codebeispiel verwenden möchten, führen Sie es von der ThisAddIn-Klasse in einem Add-In-Projekt für Word aus.

Dim vstoDoc As Document = _
    Me.Application.ActiveDocument.GetVstoObject()

vstoDoc.Paragraphs.Last.Range.InsertParagraphAfter()
Dim myPlainTextControl As PlainTextContentControl = _
    vstoDoc.Controls.AddPlainTextContentControl( _
    vstoDoc.Paragraphs.Last.Range, _
    "myPlainTextControl")
myPlainTextControl.PlaceholderText = "Insert first name"

Document vstoDoc = this.Application.ActiveDocument.GetVstoObject();

vstoDoc.Paragraphs.Last.Range.InsertParagraphAfter();
PlainTextContentControl myPlainTextControl =
    vstoDoc.Controls.AddPlainTextContentControl(
    vstoDoc.Paragraphs.Last.Range,
    "myPlainTextControl");
myPlainTextControl.PlaceholderText = "Insert first name";

Berechtigungen

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.