ListObjectExtensions.GetVstoObject 方法 (2007 system)

2008-09-04

更新：2007 年 11 月

返回一个 Excel Microsoft.Office.Tools.Excel.ListObject 宿主控件，该宿主控件扩展本机 Excel Microsoft.Office.Interop.Excel.ListObject 的功能。

命名空间： Microsoft.Office.Tools.Excel.Extensions
程序集： Microsoft.Office.Tools.Excel.v9.0（在 Microsoft.Office.Tools.Excel.v9.0.dll 中）

语法

声明
<ExtensionAttribute> _
Public Shared Function GetVstoObject ( _
    listObject As ListObject _
) As ListObject
用法
Dim listObject As ListObject
Dim returnValue As ListObject

returnValue = listObject.GetVstoObject()

public static ListObject GetVstoObject(
    this ListObject listObject
)

参数

listObject
类型：Microsoft.Office.Interop.Excel.ListObject

要扩展的列表对象。不需要您自己提供此参数。对列表对象调用此方法时，运行时会提供此参数。

返回值

类型：Microsoft.Office.Tools.Excel.ListObject

一个 Visual Studio Tools for Office Excel 列表对象宿主控件。

使用说明

在 Visual Basic 和 C# 中，可以在 ListObject 类型的任何对象上将此方法作为实例方法来调用。当使用实例方法语法调用此方法时，请省略第一个参数。有关更多信息，请参见扩展方法 (Visual Basic)或扩展方法（C# 编程指南）。

备注

可以在应用程序级外接程序中调用 GetVstoObject 方法以获取一个列表对象宿主控件。

ListObjectExtensions.GetVstoObject 方法生成一个新的扩展 Microsoft.Office.Tools.Excel.ListObject（如果还没有生成此类对象）。对此方法的后续调用会返回现有 Microsoft.Office.Tools.Excel.ListObject 对象的缓存实例。

文档级自定义项的限制

与在应用程序级外接程序中使用此方法相比，在文档级自定义项项目中使用此方法有更多限制。不能使用它为本机列表对象生成新的 Visual Studio Tools for Office 列表对象。可以使用此方法在设计时为属于自定义项项目一部分的本机列表对象获取现有的 Visual Studio Tools for Office 列表对象。有关更多信息，请参见从文档级自定义项中的本机 Office 对象获取扩展对象。

如果本机列表对象不是 Visual Studio Tools for Office 列表对象的基础对象，则此方法返回 nullnull 引用（在 Visual Basic 中为 Nothing）。

示例

下面的代码示例检查 Sheet1 中是否有任何现有的列表对象，如果有，则将该工作表中的第一个列表对象转换为 Microsoft.Office.Tools.Excel.ListObject 宿主控件并将其绑定到数据源。此示例要求定义一个 DataSet 类型的 ds 对象，该对象包含一个名为 Product 且其中包含一个名为 Name 的列的表。若要使用此代码，请从 Excel 外接程序项目的 ThisAddIn 类中运行它。

Dim mySheet As Excel.Worksheet = Me.Application.ActiveSheet
If mySheet.ListObjects.Count > 0 Then
    Dim vstoListObject As ListObject = _
        mySheet.ListObjects(1).GetVstoObject()

    vstoListObject.SetDataBinding(ds, "Product", "Name")
End If

Excel.Worksheet mySheet = (Excel.Worksheet)
    this.Application.Worksheets["Sheet1"];
if (mySheet.ListObjects.Count > 0)
{
    ListObject vstoListObject =
        mySheet.ListObjects[1].GetVstoObject();

    vstoListObject.SetDataBinding(ds, "Product", "Name");
}