ApplicationFactory.HasVstoObject メソッド (_Workbook)
指定された Excel ブック オブジェクトに、Microsoft.Office.Tools.Excel.Workbook ホスト項目が存在するかどうかを示す値を返します。
名前空間: Microsoft.Office.Tools.Excel
アセンブリ: Microsoft.Office.Tools.Excel (Microsoft.Office.Tools.Excel.dll 内)
Microsoft.Office.Tools.Excel.v4.0.Utilities (Microsoft.Office.Tools.Excel.v4.0.Utilities.dll 内)
構文
'宣言
Function HasVstoObject ( _
workbook As _Workbook _
) As Boolean
bool HasVstoObject(
_Workbook workbook
)
パラメーター
- workbook
型 : Microsoft.Office.Interop.Excel._Workbook
テストするネイティブなブック オブジェクトです。このパラメーターは Microsoft.Office.Interop.Excel._Workbook 型ですが、通常、このメソッドには Microsoft.Office.Interop.Excel.Workbook オブジェクトを渡します。
戻り値
型 : System.Boolean
指定した Microsoft.Office.Interop.Excel.Workbook オブジェクトに Microsoft.Office.Tools.Excel.Workbook ホスト項目が存在する場合は true です。それ以外の場合は false です。
解説
このメソッドをアプリケーション レベルのアドインで呼び出して、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 を使用するのが一般的です。
例
次のコード例は、現在のブックに関連するホスト項目が存在するかどうかを確認します。このコードは、実行 ThisAddIn のクラスから、ターゲット .NET Framework 4 または .NET Framework 4.5を Excel アドイン プロジェクトで使用します。
Private Sub Application_WorkbookBeforeSave( _
ByVal Wb As Microsoft.Office.Interop.Excel.Workbook, _
ByVal SaveAsUI As Boolean, _
ByRef Cancel As Boolean) Handles Application.WorkbookBeforeSave
If Globals.Factory.HasVstoObject(Wb) = True Then
For Each interopSheet As Excel.Worksheet In Wb.Worksheets
If Globals.Factory.HasVstoObject(interopSheet) = True Then
Dim vstoSheet As Worksheet = Globals.Factory.GetVstoObject(interopSheet)
If vstoSheet.Controls.Count > 0 Then
System.Windows.Forms.MessageBox.Show( _
"The VSTO controls are not persisted when you" _
+ " save and close this workbook.", _
"Controls Persistence", _
System.Windows.Forms.MessageBoxButtons.OK, _
System.Windows.Forms.MessageBoxIcon.Warning)
Exit For
End If
End If
Next
End If
End Sub
void Application_WorkbookBeforeSave(
Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI,
ref bool Cancel)
{
if (Globals.Factory.HasVstoObject(Wb) == true)
{
foreach (Excel.Worksheet interopSheet in Wb.Worksheets)
{
if (Globals.Factory.HasVstoObject(interopSheet) == true)
{
Worksheet vstoSheet = Globals.Factory.GetVstoObject(interopSheet);
if (vstoSheet.Controls.Count > 0)
{
System.Windows.Forms.MessageBox.Show(
"The VSTO controls are not persisted when you"
+ " save and close this workbook.",
"Controls Persistence",
System.Windows.Forms.MessageBoxButtons.OK,
System.Windows.Forms.MessageBoxIcon.Warning);
break;
}
}
}
}
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。