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

Статья
11/16/2008

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

Возвращает ведущий элемент листа Excel, который расширяет функциональность собственного листа Excel.

Пространство имен: Microsoft.Office.Tools.Excel.Extensions
Сборка: Microsoft.Office.Tools.Excel.v9.0 (в Microsoft.Office.Tools.Excel.v9.0.dll)

Синтаксис

'Декларация
<ExtensionAttribute> _
Public Shared Function GetVstoObject ( _
    worksheet As _Worksheet _
) As Worksheet
'Применение
Dim worksheet As _Worksheet
Dim returnValue As Worksheet

returnValue = worksheet.GetVstoObject()

public static Worksheet GetVstoObject(
    this _Worksheet worksheet
)

Параметры

worksheet
Тип: Microsoft.Office.Interop.Excel._Worksheet
Лист, который требуется расширить. Не предоставляйте этот параметр вручную. Если вы вызовете этот метод для листа Excel, данный параметр будет предоставлен во время выполнения.

Возвращаемое значение

Тип: Microsoft.Office.Tools.Excel.Worksheet
Ведущий элемент листа Excel Visual Studio Tools for Office.

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

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

Заметки

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

Метод WorksheetExtensions.GetVstoObject создает новый расширенный объект Microsoft.Office.Tools.Excel.Worksheet, если такой объект еще не был создан. Последующие вызовы данного метода возвращают кэшированный экземпляр существующего объекта Microsoft.Office.Tools.Excel.Worksheet.

Примечание.
Параметр worksheet является типом Microsoft.Office.Interop.Excel._Worksheet, который является родительским интерфейсом Microsoft.Office.Interop.Excel.Worksheet. Следовательно, этот метод расширяет оба типа: как Microsoft.Office.Interop.Excel._Worksheet, так и Microsoft.Office.Interop.Excel.Worksheet. Обычно при ссылке на лист Excel используетсяMicrosoft.Office.Interop.Excel.Worksheet.

Параметр worksheet является типом Microsoft.Office.Interop.Excel._Worksheet, который является родительским интерфейсом Microsoft.Office.Interop.Excel.Worksheet. Следовательно, этот метод расширяет оба типа: как Microsoft.Office.Interop.Excel._Worksheet, так и Microsoft.Office.Interop.Excel.Worksheet. Обычно при ссылке на лист Excel используетсяMicrosoft.Office.Interop.Excel.Worksheet.

Ограничения в настройках уровня документа

В проекте настройки уровня документа этот метод имеет больше ограничений при использовании, чем в надстройке уровня приложения. Нельзя использовать его для создания нового листа Excel Visual Studio Tools for Office для собственного листа Excel. Можно использовать этот метод для возвращения листа Excel Visual Studio Tools for Office, который являлся частью проекта настроек на этапе проектирования. Дополнительные сведения см. в разделе Получение вложенных объектов из собственных объектов Office в настройках уровня документа.

Если собственный лист Excel не является базовым объектом листа Excel Visual Studio Tools for Office, то данный метод возвращает nullссылка null (Nothing в Visual Basic).

Пример использования данного метода в надстройке уровня документа, см. в разделе Добавление элементов управления в документы Office во время выполнения.

Примеры

Следующий пример кода возвращает объект листа Visual Studio Tools for Office для Sheet2, вызывая метод расширения GetVstoObject для собственного объекта листа. Затем в примере ведущий элемент ListObject добавляется в лист. Чтобы использовать данный кода, запустите его из класса ThisAddIn в проекте надстройки Excel.

Private Sub AddVstoHostControl()
    Dim interopWorksheet As Excel.Worksheet = _
        Me.Application.ActiveWorkbook.Worksheets("Sheet2")
    Dim vstoWorksheet As Worksheet = interopWorksheet.GetVstoObject()

    Dim myTable As ListObject = vstoWorksheet.Controls.AddListObject( _
        vstoWorksheet.Range("A1"), _
        "myTable")
    myTable.InsertRowRange.Value2 = "10"
End Sub

private void AddVstoHostControl()
{
    Excel.Worksheet interopWorksheet = (Excel.Worksheet)
        this.Application.ActiveWorkbook.Worksheets["Sheet2"];
    Worksheet vstoWorksheet =
        interopWorksheet.GetVstoObject();

    ListObject myTable = vstoWorksheet.Controls.AddListObject(
        vstoWorksheet.Range["A1", missing],
        "myTable");
    myTable.InsertRowRange.Value2 = "10";
}

Разрешения

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