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

Статья
11/16/2008

Обновлен: Ноябрь 2007

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

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

Синтаксис

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

returnValue = document.GetVstoObject()

public static Document GetVstoObject(
    this _Document document
)

Параметры

document
Тип: Microsoft.Office.Interop.Word._Document

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

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

Примечание об использовании

В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа _Document. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе Методы расширения (Visual Basic) или Методы расширения (руководство по программированию в C#).

Заметки

Вызовите этот метод в надстройке уровня приложения, чтобы настроить любой открытый в 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 создается объект Visual Studio Tools for Office Microsoft.Office.Tools.Word.Document. Затем в примере в документ добавляется элемент управления обычным текстом. Чтобы использовать данный код, запустите его из класса ThisAddIn в проекте надстройки Word.

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

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

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

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

Разрешения

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