ListObjectExtensions.GetVstoObject Метод (2007 System)

Статья
11/16/2008

Обновлен: Ноябрь 2007

Возвращает ведущий элемент управления 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
Элемент управления ведущего приложения объекта списка Excel Visual Studio Tools for Office.

Примечание об использовании

В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа ListObject. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе Методы расширения (Visual Basic) или Методы расширения (руководство по программированию в C#).

Заметки

Можно вызвать метод GetVstoObject в надстройке уровня приложения, чтобы получить ведущий элемент управления объекта списка Excel.

Метод 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, данный метод возвращает nullссылка null (Nothing в Visual Basic).

Примеры

В следующем примере кода проверяется наличие объектов списка на листе Sheet1, и если они есть, то выполняется преобразование первого объекта списка в ведущий элемент управления Microsoft.Office.Tools.Excel.ListObject и этот элемент привязывается к источнику данных. Для данного примера требуется объект ds типа DataSet, который должен быть определен, как содержащий таблицу с именем Product со столбцами Name. Чтобы использовать данный код, запустите его из класса ThisAddIn в проекте надстройки Excel.

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");
}

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.