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

Статья
11/16/2008

Обновлен: Июль 2008

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

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

Синтаксис

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

returnValue = Worksheet.GetVstoObject(worksheet)

public static Worksheet GetVstoObject(
    _Worksheet worksheet
)

Параметры

worksheet
Тип: Microsoft.Office.Interop.Excel._Worksheet
Собственный объект листа Excel.

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

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

Заметки

Вызов данного метода равносилен вызову метода WorksheetExtensions.GetVstoObject. Единственная разница в том, что это статический метод (Shared в Visual Basic), который следует вызывать для типа Microsoft.Office.Tools.Excel.Worksheet, в котором метод WorksheetExtensions.GetVstoObject должен быть вызван для объекта Microsoft.Office.Interop.Excel.Worksheet.

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

Этот метод создает новый расширенный объект 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).

Примеры

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

Private Sub AddVstoHostControlToWorksheet()
    Dim interopWorksheet As Excel.Worksheet = _
        CType(Me.Application.ActiveWorkbook.Worksheets("Sheet2"),  _
        Excel.Worksheet)

    Dim vstoWorksheet As Worksheet = Worksheet.GetVstoObject( _
        interopWorksheet)

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

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

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

Разрешения

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