Workbook.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 ( _
    workbook As _Workbook _
) As Workbook
'Применение
Dim workbook As _Workbook
Dim returnValue As Workbook

returnValue = Workbook.GetVstoObject(workbook)

public static Workbook GetVstoObject(
    _Workbook workbook
)

Параметры

workbook
Тип: Microsoft.Office.Interop.Excel._Workbook
Собственный объект книги Excel.

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

Тип: Microsoft.Office.Tools.Excel.Workbook
Ведущий элемент книги Excel Visual Studio Tools for Office.

Заметки

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

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

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

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

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

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

В проекте настройки уровня документа этот метод имеет больше ограничений при использовании, чем в надстройке уровня приложения. Нельзя использовать его для создания новой книги 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).

Примеры

В следующем примере кода вызывается данный метод для типа Microsoft.Office.Tools.Excel.Workbook, чтобы получить объект Visual Studio Tools for Office Microsoft.Office.Tools.Excel.Workbook. Затем в примере проверяется, существуют ли какие-нибудь смарт-теги, определенные для данной книги и отображается, есть ли ненайденные смарт-теги или сообщения. Чтобы использовать данный код, запустите его из класса ThisAddIn в проекте надстройки Excel.

Dim vstoWorkbook As Workbook = Workbook.GetVstoObject( _
    Me.Application.ActiveWorkbook)

Dim sb As StringBuilder = New StringBuilder()
If vstoWorkbook.VstoSmartTags.Count > 0 Then
    sb.Append("VSTO smart tags found in this workbook:")
Else
    sb.Append("No VSTO smart tags were found in this workbook.")
End If

For Each st As SmartTag In vstoWorkbook.VstoSmartTags
    sb.Append(vbCrLf + st.Caption)
Next
System.Windows.Forms.MessageBox.Show(sb.ToString())

Workbook vstoWorkbook = Workbook.GetVstoObject(
    this.Application.ActiveWorkbook);

StringBuilder sb = new StringBuilder();
if (vstoWorkbook.VstoSmartTags.Count > 0)
{
    sb.Append("VSTO smart tags found in this workbook:");
}
else
{
    sb.Append("No VSTO smart tags were found in this workbook.");
}

foreach (SmartTag st in vstoWorkbook.VstoSmartTags)
{
    sb.Append("\r\n" + st.Caption);
}
System.Windows.Forms.MessageBox.Show(sb.ToString());

Разрешения

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