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

Статья
11/16/2008

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

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

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

Синтаксис

'Декларация
Public Shared Function GetVstoObject ( _
    document As _Document _
) As Document
'Применение
Dim document As _Document
Dim returnValue As Document

returnValue = Document.GetVstoObject(document)

public static Document GetVstoObject(
    _Document document
)

Параметры

document
Тип: Microsoft.Office.Interop.Word._Document
Объект исходного документа Word.

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

Тип: Microsoft.Office.Tools.Word.Document
Ведущий элемент документа Word Visual Studio Tools for Office.

Заметки

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

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

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

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

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

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

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

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

Примеры

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

Dim vstoDoc As Document = Document.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 = Document.GetVstoObject(
    this.Application.ActiveDocument);

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

Разрешения

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