WorkbookExtensions.HasVstoObject Method (_Workbook, Factory)
Returns a value that indicates whether a Microsoft.Office.Tools.Excel.Workbook host item has been created for the current Microsoft.Office.Interop.Excel.Workbook object in a document-level customization. Pass the Globals.Factory object in your project to the factory parameter.
Namespace: Microsoft.Office.Tools.Excel.Extensions
Assembly: Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function HasVstoObject ( _
workbook As _Workbook, _
factory As Factory _
) As Boolean
public static bool HasVstoObject(
this _Workbook workbook,
Factory factory
)
Parameters
workbook
Type: Microsoft.Office.Interop.Excel._WorkbookThe native workbook object to test. Do not supply this parameter yourself. When you call this method on an Excel workbook, the runtime supplies this parameter.
factory
Type: Microsoft.Office.Tools.Excel.FactoryAn object that provides access to certain features in your document-level customization. Pass the Globals.Factory object to this parameter.
Return Value
Type: System.Boolean
true if a Microsoft.Office.Tools.Excel.Workbook host item has been created for the current Microsoft.Office.Interop.Excel.Workbook object; otherwise, false.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type _Workbook. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
In a document-level customization, this method returns true only if the Microsoft.Office.Interop.Excel.Workbook object on which you call this method is the underlying object of a Microsoft.Office.Tools.Excel.Workbook host item in the current customization. Otherwise, this method returns false.
This method is provided for backward compatibility with Office projects that you retarget from the .NET Framework 3.5 to the .NET Framework 4. In new projects that target the .NET Framework 4 or the .NET Framework 4.5, you should call the HasVstoObject method that is provided by the Globals.Factory object in your project. For more information, see Programming Document-Level Customizations.
Note
The Workbook parameter is of type Microsoft.Office.Interop.Excel._Workbook, which is the parent interface of Microsoft.Office.Interop.Excel.Workbook. Therefore, this method extends both types: Microsoft.Office.Interop.Excel._Workbook and Microsoft.Office.Interop.Excel.Workbook. Typically, when you reference an Excel workbook, you use a Microsoft.Office.Interop.Excel.Workbook.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
See Also
Reference
Microsoft.Office.Tools.Excel.Extensions Namespace
Other Resources
Programming Document-Level Customizations