DocumentExtensions.GetVstoObject 方法 (2007 system)

项目
09/04/2008

更新：2007 年 11 月

返回一个扩展本机 Word 文档功能的文档宿主项。

命名空间： Microsoft.Office.Tools.Word.Extensions
程序集： Microsoft.Office.Tools.Word.v9.0（在 Microsoft.Office.Tools.Word.v9.0.dll 中）

语法

声明
<ExtensionAttribute> _
Public Shared Function GetVstoObject ( _
    document As _Document _
) As Document
用法
Dim document As _Document
Dim returnValue As Document

returnValue = document.GetVstoObject()

public static Document GetVstoObject(
    this _Document document
)

参数

document
类型：Microsoft.Office.Interop.Word._Document

返回值

类型：Microsoft.Office.Tools.Word.Document

一个 Visual Studio Tools for Office Word 文档宿主项。

使用说明

在 Visual Basic 和 C# 中，可以在 _Document 类型的任何对象上将此方法作为实例方法来调用。当使用实例方法语法调用此方法时，请省略第一个参数。有关更多信息，请参见扩展方法 (Visual Basic)或扩展方法（C# 编程指南）。

备注

在应用程序级外接程序中调用此方法可自定义在 Word 中打开的任何文档。此方法返回一个 Microsoft.Office.Tools.Word.Document 宿主项。

此方法会生成一个新的 Microsoft.Office.Tools.Word.Document 对象（如果还没有生成此类对象）。对此方法的后续调用会返回现有 Microsoft.Office.Tools.Word.Document 对象的缓存实例。

说明：
document 参数为 Microsoft.Office.Interop.Word._Document 类型，它是 Microsoft.Office.Interop.Word.Document 的父接口。因此，此方法可扩展以下两种类型：Microsoft.Office.Interop.Word._Document 和 Microsoft.Office.Interop.Word.Document。通常情况下，引用 Word 文档时，使用 Microsoft.Office.Interop.Word.Document。

文档级自定义的限制

与在应用程序级外接程序中使用此方法相比，在文档级自定义项目中使用此方法有更多限制。不能使用它为本机 Word 文档生成新的 Visual Studio Tools for Office Word 文档。可以使用此方法在设计时获取属于自定义项目一部分的现有 Visual Studio Tools for Office Word 文档。有关更多信息，请参见从文档级自定义项中的本机 Office 对象获取扩展对象。

如果本机 Word 文档不是 Visual Studio Tools for Office Word 文档的基础对象，则此方法返回 nullnull 引用（在 Visual Basic 中为 Nothing）。

示例

下面的代码示例从活动的 Word 文档获取 Visual Studio Tools for Office Microsoft.Office.Tools.Word.Document 对象。然后该示例向文档中添加一个纯文本内容控件。若要使用这些代码，请从 Word 外接程序项目的 ThisAddIn 类中运行它们。

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";