DocumentExtensions.GetVstoObject メソッド (2007 System)

[アーティクル]
08/22/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 および Visual 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 を使用するのが一般的です。

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