ApplicationFactory.GetVstoObject - метод

Статья
08/11/2011

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

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

Синтаксис

'Декларация
Function GetVstoObject ( _
    document As _Document _
) As Document

Document GetVstoObject(
    _Document document
)

Параметры

document
Тип: Microsoft.Office.Interop.Word._Document
Собственный объект документа для расширения.Хотя этот параметр принадлежит к типу Microsoft.Office.Interop.Word._Document, как правило, этому методу передается объект Microsoft.Office.Interop.Word.Document.

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

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

Заметки

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

Примечание

Параметр document является типом Microsoft.Office.Interop.Word._Document, который является родительским интерфейсом Microsoft.Office.Interop.Word.Document).Следовательно, этот метод может принимать объекты обоих типов: Microsoft.Office.Interop.Word._Document и Microsoft.Office.Interop.Word.Document.Как правило, когда необходимо сослаться на документ Word, используется объект Microsoft.Office.Interop.Word.Document.

Примеры

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

Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)

vstoDoc.Paragraphs.Last.Range.InsertParagraphAfter()
Dim myPlainTextControl As PlainTextContentControl = _
    vstoDoc.Controls.AddPlainTextContentControl( _
    vstoDoc.Paragraphs.Last.Range, _
    "myPlainTextControl")
myPlainTextControl.PlaceholderText = "Insert first name"

Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);

vstoDoc.Paragraphs.Last.Range.InsertParagraphAfter();
PlainTextContentControl myPlainTextControl =
    vstoDoc.Controls.AddPlainTextContentControl(
    vstoDoc.Paragraphs.Last.Range,
    "myPlainTextControl");
myPlainTextControl.PlaceholderText = "Insert first name";

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

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