ApplicationFactory.GetVstoObject メソッド (_Workbook)

2011-08-09

指定されたネイティブなブックオブジェクトの機能を拡張する Microsoft.Office.Tools.Excel.Workbook ホスト項目を返します。

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

構文

'宣言
Function GetVstoObject ( _
    workbook As _Workbook _
) As Workbook

Workbook GetVstoObject(
    _Workbook workbook
)

パラメーター

workbook
型: Microsoft.Office.Interop.Excel._Workbook
拡張されたオブジェクトを取得する、ネイティブなブックオブジェクトです。このパラメーターは Microsoft.Office.Interop.Excel._Workbook 型ですが、通常、このメソッドには Microsoft.Office.Interop.Excel.Workbook オブジェクトを渡します。

戻り値

型: Microsoft.Office.Tools.Excel.Workbook
ネイティブなブックオブジェクトの機能を拡張するホスト項目です。

解説

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

注意

workbook パラメーターの型は、Microsoft.Office.Interop.Excel.Workbook の親インターフェイスである Microsoft.Office.Interop.Excel._Workbook 型です。したがって、このメソッドは、Microsoft.Office.Interop.Excel._Workbook と Microsoft.Office.Interop.Excel.Workbook の両方の種類のオブジェクトを受け取ることができます。 Excel ブックを参照する場合は、Microsoft.Office.Interop.Excel.Workbook を使用するのが一般的です。

例

アクティブな Excel ブックの Microsoft.Office.Tools.Excel.Workbook ホスト項目を作成するコード例を次に示します。このコードを使用するには、.NET Framework 4 を対象とする Excel アドインプロジェクトの ThisAddIn クラスから実行します。

Dim vstoWorkbook As Workbook = _
    Globals.Factory.GetVstoObject(Me.Application.ActiveWorkbook)

For Each st As SmartTag In vstoWorkbook.VstoSmartTags
    System.Windows.Forms.MessageBox.Show(st.Caption)
Next

Workbook vstoWorkbook =
    Globals.Factory.GetVstoObject(this.Application.ActiveWorkbook);

foreach (SmartTag st in vstoWorkbook.VstoSmartTags)
{
    System.Windows.Forms.MessageBox.Show(st.Caption);
}