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

Статья
11/16/2008

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

Возвращает значение, указывающее, был ли создан ведущий элемент Word Microsoft.Office.Tools.Word.Document для указанного исходного документа Word Microsoft.Office.Interop.Word._Document.

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

Синтаксис

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

returnValue = Document.HasVstoObject(document)

public static bool HasVstoObject(
    _Document document
)

Параметры

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

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

Тип: System.Boolean
Возвращает true, если ведущий элемент документа был создан для указанного исходного документа Word; в противном случае возвращается значение false.

Заметки

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

Например, этот метод можно вызвать в надстройке уровня приложения и, если метод вернет значение true, можно проверить наличие в документе управляемых элементов управления, которые необходимо сохранить перед закрытием или сохранением документа Word.

Также можно использовать данный метод в настройках уровня документа.

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

Примеры

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

Private Sub Application_DocumentBeforeClose( _
    ByVal Doc As Microsoft.Office.Interop.Word.Document, _
    ByRef Cancel As Boolean) Handles Application.DocumentBeforeClose

    If Document.HasVstoObject(Doc) = True Then
        Dim vstoDoc As Document = Document.GetVstoObject( _
            Me.Application.ActiveDocument)
        If vstoDoc.Controls.Count > 0 Then
            System.Windows.Forms.MessageBox.Show( _
                "The VSTO controls are not persisted when you" _
                + " save this document.", _
                "Controls Persistence", _
                System.Windows.Forms.MessageBoxButtons.OK, _
                System.Windows.Forms.MessageBoxIcon.Warning)
        End If
    End If
End Sub

void Application_DocumentBeforeClose(
    Microsoft.Office.Interop.Word.Document Doc, ref bool Cancel)
{
    if (Document.HasVstoObject(Doc) == true)
    {
        Document vstoDoc = Document.GetVstoObject(
            this.Application.ActiveDocument);
        if (vstoDoc.Controls.Count > 0)
        {
            System.Windows.Forms.MessageBox.Show(
                "The VSTO controls are not persisted when you"
                + " save this document.",
                "Controls Persistence",
                System.Windows.Forms.MessageBoxButtons.OK,
                System.Windows.Forms.MessageBoxIcon.Warning);
        }
    }
}

Разрешения

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