Factory.GetVstoObject Method

Definition

Overloads

GetVstoObject(_Workbook)

Returns a Workbook host item that extends the functionality of the specified native workbook object.

GetVstoObject(_Worksheet)

Returns a Worksheet host item that extends the functionality of the specified native workbook object.

GetVstoObject(ListObject)

Returns a ListObject that extends the functionality of the specified native list object.

GetVstoObject(_Workbook)

Returns a Workbook host item that extends the functionality of the specified native workbook object.

public:
 Microsoft::Office::Tools::Excel::Workbook ^ GetVstoObject(Microsoft::Office::Interop::Excel::_Workbook ^ workbook);
public Microsoft.Office.Tools.Excel.Workbook GetVstoObject (Microsoft.Office.Interop.Excel._Workbook workbook);
abstract member GetVstoObject : Microsoft.Office.Interop.Excel._Workbook -> Microsoft.Office.Tools.Excel.Workbook
Public Function GetVstoObject (workbook As _Workbook) As Workbook

Parameters

workbook
_Workbook

The native workbook object for which to retrieve the extended object. Although this parameter is of type _Workbook, you typically pass a Workbook object to this method.

Returns

The host item that extends the functionality of the native workbook object, if the native workbook is the underlying object of a Workbook object in the current document-level customization; otherwise, null.

Remarks

In a document-level customization, you cannot use this method to generate a new extended Microsoft.Office.Tools.Excel.Workbook object for a native workbook object. You can use this method only to get a Microsoft.Office.Tools.Excel.Workbook object that is in the current customization. For more information, see Programming Document-Level Customizations.

Applies to

GetVstoObject(_Worksheet)

Returns a Worksheet host item that extends the functionality of the specified native workbook object.

public:
 Microsoft::Office::Tools::Excel::Worksheet ^ GetVstoObject(Microsoft::Office::Interop::Excel::_Worksheet ^ worksheet);
public Microsoft.Office.Tools.Excel.Worksheet GetVstoObject (Microsoft.Office.Interop.Excel._Worksheet worksheet);
abstract member GetVstoObject : Microsoft.Office.Interop.Excel._Worksheet -> Microsoft.Office.Tools.Excel.Worksheet
Public Function GetVstoObject (worksheet As _Worksheet) As Worksheet

Parameters

worksheet
_Worksheet

The native worksheet object for which to retrieve the extended object. Although this parameter is of type _Worksheet, you typically pass a Worksheet object to this method.

Returns

The host item that extends the functionality of the native worksheet object, if the native worksheet is the underlying object of a Worksheet object in the current document-level customization; otherwise, null.

Remarks

In a document-level customization, you cannot use this method to generate a new extended Microsoft.Office.Tools.Excel.Worksheet object for a native worksheet object. You can use this method only to get a Microsoft.Office.Tools.Excel.Worksheet object that is in the current customization. For more information, see Programming Document-Level Customizations.

Applies to

GetVstoObject(ListObject)

Returns a ListObject that extends the functionality of the specified native list object.

public:
 Microsoft::Office::Tools::Excel::ListObject ^ GetVstoObject(Microsoft::Office::Interop::Excel::ListObject ^ listObject);
public Microsoft.Office.Tools.Excel.ListObject GetVstoObject (Microsoft.Office.Interop.Excel.ListObject listObject);
abstract member GetVstoObject : Microsoft.Office.Interop.Excel.ListObject -> Microsoft.Office.Tools.Excel.ListObject
Public Function GetVstoObject (listObject As ListObject) As ListObject

Parameters

listObject
ListObject

The native list object for which to retrieve the extended object.

Returns

The object that extends the functionality of the native list object, if the list object is the underlying object of a ListObject object in the current document-level customization; otherwise, null.

Remarks

In a document-level customization, you cannot use this method to generate a new extended Microsoft.Office.Tools.Excel.ListObject object for a native list object. You can use this method only to get a Microsoft.Office.Tools.Excel.ListObject object that is in the current customization. For more information, see Programming Document-Level Customizations.

Applies to