ApplicationFactory.GetVstoObject - метод (_Workbook)

Статья
08/11/2011

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

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

Синтаксис

'Декларация
Function GetVstoObject ( _
    workbook As _Workbook _
) As Workbook

Workbook GetVstoObject(
    _Workbook workbook
)

Параметры

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

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

Тип: Microsoft.Office.Tools.Excel.Workbook
Ведущий элемент, расширяющий функциональность указанного собственного объекта книги.

Заметки

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

Примечание

Параметр 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.

Примеры

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

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

For Each st As SmartTag In vstoWorkbook.VstoSmartTags
    System.Windows.Forms.MessageBox.Show(st.Caption)
Next

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

foreach (SmartTag st in vstoWorkbook.VstoSmartTags)
{
    System.Windows.Forms.MessageBox.Show(st.Caption);
}

Безопасность платформы .NET Framework

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