WorkbookExtensions.HasVstoObject メソッド (_Workbook, Factory)

2011-08-09

ドキュメントレベルのカスタマイズにおいて、現在の Microsoft.Office.Interop.Excel.Workbook オブジェクトに対して Microsoft.Office.Tools.Excel.Workbook ホスト項目が作成されているかどうかを示す値を取得します。プロジェクト内の Globals.Factory オブジェクトを factory パラメーターに渡します。

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

構文

'宣言
<ExtensionAttribute> _
Public Shared Function HasVstoObject ( _
    workbook As _Workbook, _
    factory As Factory _
) As Boolean

public static bool HasVstoObject(
    this _Workbook workbook,
    Factory factory
)

パラメーター

workbook
型: Microsoft.Office.Interop.Excel._Workbook
テストするネイティブなブックオブジェクトです。このパラメーターは手動で指定しないでください。このパラメーターは、Excel ブックでこのメソッドを呼び出したときに、ランタイムによって指定されます。

factory
型: Microsoft.Office.Tools.Excel.Factory
ドキュメントレベルのカスタマイズ内で特定の機能へのアクセスを提供するオブジェクト。Globals.Factory オブジェクトをこのパラメーターに渡します。

戻り値

型: System.Boolean
現在の Microsoft.Office.Interop.Excel.Workbook オブジェクトに対して Microsoft.Office.Tools.Excel.Workbook ホスト項目が作成されている場合は true。それ以外の場合は false。

使用上の注意

Visual Basic および Visual C# では、このメソッドを、_Workbook 型のオブジェクトのインスタンスメソッドとして呼び出すことができます。インスタンスメソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。詳細については、「拡張メソッド (Visual Basic)」または「拡張メソッド (C# プログラミングガイド)」を参照してください。

解説

ドキュメントレベルのカスタマイズでは、このメソッド呼び出しを行う Microsoft.Office.Interop.Excel.Workbook オブジェクトが現在のカスタマイズで Microsoft.Office.Tools.Excel.Workbook ホスト項目の基になるオブジェクトの場合に限り、このメソッドは true を返します。それ以外の場合、このメソッドは false を返します。

このメソッドは、.NET Framework 3.5 から .NET Framework 4 に対象を変更する Office プロジェクトとの下位互換性のために用意されています。 .NET Framework 4 を対象とするプロジェクトでは、プロジェクトの Globals.Factory オブジェクトが提供する HasVstoObject メソッドを呼び出す必要があります。詳細については、「ドキュメントレベルのカスタマイズにおけるネイティブな Office オブジェクトからの拡張オブジェクトの取得」を参照してください。

注意

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 を使用するのが一般的です。