WorksheetExtensions.GetVstoObject メソッド (_Worksheet, Factory)

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 GetVstoObject ( _
    worksheet As _Worksheet, _
    factory As Factory _
) As Worksheet

public static Worksheet GetVstoObject(
    this _Worksheet worksheet,
    Factory factory
)

パラメーター

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

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

戻り値

型: Microsoft.Office.Tools.Excel.Worksheet
現在の Microsoft.Office.Interop.Excel.Worksheet オブジェクトの機能を拡張するホスト項目。

使用上の注意

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

解説

ドキュメントレベルのカスタマイズでは、このメソッドを呼び出すことにより、現在のカスタマイズの Microsoft.Office.Tools.Excel.Worksheet ホスト項目を取得できます。このメソッドを呼び出す Microsoft.Office.Interop.Excel.Worksheet オブジェクトが、現在カスタマイズで Microsoft.Office.Tools.Excel.Worksheet ホスト項目の基になるオブジェクトではない場合は、このメソッドは nullnull 参照 (Visual Basic では Nothing) を返します。

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

注意

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