ApplicationFactory.GetVstoObject メソッド

[アーティクル]
08/09/2011

指定したネイティブなドキュメントオブジェクトの機能を拡張する Microsoft.Office.Tools.Word.Document ホスト項目を取得します。

名前空間: Microsoft.Office.Tools.Word
アセンブリ: Microsoft.Office.Tools.Word (Microsoft.Office.Tools.Word.dll 内)

構文

'宣言
Function GetVstoObject ( _
    document As _Document _
) As Document

Document GetVstoObject(
    _Document document
)

パラメーター

document
型: Microsoft.Office.Interop.Word._Document
拡張するネイティブなドキュメントオブジェクト。このパラメーターは Microsoft.Office.Interop.Word._Document 型ですが、通常、このメソッドには Microsoft.Office.Interop.Word.Document オブジェクトを渡します。

戻り値

型: Microsoft.Office.Tools.Word.Document
ネイティブなドキュメントオブジェクトの機能を拡張するホスト項目。

解説

このメソッドは、アプリケーションレベルのアドインから、Word で開いている文書をカスタマイズする際に呼び出します。既存の Microsoft.Office.Tools.Word.Document オブジェクトが存在しない場合は、新しいオブジェクトが生成されます。それ以降の呼び出しでは、既存の Microsoft.Office.Tools.Word.Document オブジェクトのキャッシュされたインスタンスが返されます。詳細については、「アプリケーションレベルのアドインにおける実行時の Word 文書や Excel ブックの拡張」を参照してください。

注意

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 文書の Microsoft.Office.Tools.Word.Document ホスト項目を作成します。次に、PlainTextContentControl をドキュメントに追加します。このコードを実行するには、.NET Framework 4 をターゲットとする Word アドインプロジェクトの ThisAddIn クラスから実行します。

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

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

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

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