WorksheetExtensions.HasVstoObject メソッド (_Worksheet, ApplicationFactory)

2011-08-09

アプリケーションレベルのアドイン内で現在の Microsoft.Office.Interop.Excel.Worksheet オブジェクトに対して Microsoft.Office.Tools.Excel.Worksheet ホスト項目が作成されているかどうかを示す値を返します。プロジェクト内の 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 ( _
    worksheet As _Worksheet, _
    factory As ApplicationFactory _
) As Boolean

public static bool HasVstoObject(
    this _Worksheet worksheet,
    ApplicationFactory factory
)

パラメーター

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

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

戻り値

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

使用上の注意

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

解説

アプリケーションレベルのアドインでは、このメソッドを呼び出すことにより、任意の Microsoft.Office.Interop.Excel.Worksheet オブジェクトに Microsoft.Office.Tools.Excel.Worksheet ホスト項目が存在するかどうかを判断できます。通常、このメソッドを使用して、Excel ワークシートを閉じたり保存したりする前に永続化する必要のあるマネージコントロールが存在するかどうかをテストできます。

このメソッドは、.NET Framework 3.5 から .NET Framework 4 に対象を変更する Office プロジェクトとの下位互換性のために用意されています。 .NET Framework 4 を対象とするプロジェクトでは、プロジェクトの Globals.Factory オブジェクトが提供する GetVstoObject メソッドを呼び出す必要があります。詳細については、「アプリケーションレベルのアドインにおける実行時の Word 文書や Excel ブックの拡張」を参照してください。

注意

Worksheet パラメーターの型は、Microsoft.Office.Interop.Excel.Worksheet の親インターフェイスである Microsoft.Office.Interop.Excel._Worksheet 型です。したがって、このメソッドは、Microsoft.Office.Interop.Excel._Worksheet と Microsoft.Office.Interop.Excel.Worksheet の両方の型を拡張します。 Excel ワークシートを参照する場合は、Microsoft.Office.Interop.Excel.Worksheet を使用するのが一般的です。