RibbonComponent.Tag - свойство

Статья
05/19/2013

Возврат или установка данных приложения, связанных с этим объектом RibbonComponent.

Пространство имен: Microsoft.Office.Tools.Ribbon
Сборки: Microsoft.Office.Tools.Common (в Microsoft.Office.Tools.Common.dll)
Microsoft.Office.Tools.Common.v4.0.Utilities (в Microsoft.Office.Tools.Common.v4.0.Utilities.dll)

Синтаксис

'Декларация
Property Tag As Object

Object Tag { get; set; }

Значение свойства

Тип: System.Object
Объект System.Object, представляющий данные приложения, связанные с этим объектом RibbonComponent.

Заметки

Данному свойству можно назначить любой тип, производный от класса System.Object.Однако при установке свойства Tag в окне Свойства среды Visual Studio можно присваивать ему только текстовые значения.

Обычно свойство Tag применяется для хранения данных, связанных с элементом управления.Например, в приложении используется кнопка, с помощью которой отображаются сведения о покупателе. Можно сохранить объект System.Data.DataSet, содержащий историю заказов покупателя, в свойстве Tag этой кнопки, чтобы обеспечить быстрый доступ к данным.

Примеры

В следующем примере демонстрируется назначение массива объектов Employee свойству Tag группы и извлечение значения свойства Tag.Для этого примера требуется определить класс с именем Employee, предоставляющий свойство StringID и реализующий метод GetEmployees, который возвращает массив объектов Employee.

Перед выполнением этого примера выполните следующие действия:

Добавьте элемент Лента (визуальный конструктор) в проект, созданный с использованием средств разработки для Office в Visual Studio.
Добавьте кнопку в группу по умолчанию Group1.

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Button1.Click
    ' Set the group's Tag property
    Group1.Tag = GetEmployees()

    ' Show all customers by retrieving them from the group's Tag property
    For Each emp As Employee In CType(Group1.Tag, Employee())
        System.Windows.Forms.MessageBox.Show(emp.ID)
    Next
End Sub

private void button1_Click(object sender, RibbonControlEventArgs e)
{
    // Set the group's Tag property
    group1.Tag = GetEmployees();

    // Show all customers by retrieving them from the group's Tag property
    foreach (Employee emp in (Employee[])group1.Tag)
    {
        System.Windows.Forms.MessageBox.Show(emp.ID);
    }
}

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

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

См. также

Ссылки

RibbonComponent Интерфейс

Microsoft.Office.Tools.Ribbon - пространство имен

Поделиться через