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

Статья
11/16/2008

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

Возвращает значение, указывающее, создан ли ведущий элемент управления Excel Microsoft.Office.Tools.Excel.ListObject для текущего объекта списка Excel в машинном коде Microsoft.Office.Interop.Excel.ListObject.

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

Синтаксис

'Декларация
<ExtensionAttribute> _
Public Shared Function HasVstoObject ( _
    listObject As ListObject _
) As Boolean
'Применение
Dim listObject As ListObject
Dim returnValue As Boolean

returnValue = listObject.HasVstoObject()

public static bool HasVstoObject(
    this ListObject listObject
)

Параметры

listObject
Тип: Microsoft.Office.Interop.Excel.ListObject
Объект, который требуется расширить. Не предоставляйте этот параметр вручную. Если вы вызовете этот метод для объекта списка, данный параметр будет предоставлен во время выполнения.

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

Тип: System.Boolean
Возвращает ведущий элемент управленияtrue if a Microsoft.Office.Tools.Excel.ListObject был создан для собственного объекта списка Excel Microsoft.Office.Interop.Excel.ListObject; в противном случае возвращается false.

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

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

Заметки

Можно вызвать метод расширения HasVstoObject в надстройке уровня приложения, чтобы проверить наличие объектов списка, которые вы хотите сохранить, перед сохранением книги. Пример, показывающий, как сохранить управляющие элементы в книге Excel, см. в разделе Пример динамических элементов управления надстройками Excel.

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

Примеры

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

Dim mySheet As Excel.Worksheet = Me.Application.ActiveSheet
If mySheet.ListObjects.Count > 0 Then
    For Each list As Excel.ListObject In mySheet.ListObjects
        If list.HasVstoObject() = True Then
            System.Windows.Forms.MessageBox.Show( _
                "The VSTO properties of list objects are not " _
                + "persisted when you save and close this workbook.", _
                "VSTO ListObject", _
                System.Windows.Forms.MessageBoxButtons.OK, _
                System.Windows.Forms.MessageBoxIcon.Warning)
            Exit For
        End If
    Next
End If

Excel.Worksheet mySheet = (Excel.Worksheet)
    this.Application.Worksheets["Sheet1"];
if (mySheet.ListObjects.Count > 0)
{
    foreach (Excel.ListObject list in mySheet.ListObjects)
    {
        if (list.HasVstoObject() == true)
        {
            System.Windows.Forms.MessageBox.Show(
                "The VSTO properties of list objects are not "
                + "persisted when you save and close this workbook.",
                "VSTO ListObject",
                System.Windows.Forms.MessageBoxButtons.OK,
                System.Windows.Forms.MessageBoxIcon.Warning);
            break;
        }
    }
}

Разрешения

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