RibbonComponent.Tag 属性

定义

命名空间:

Microsoft.Office.Tools.Ribbon

程序集:

Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

获取或设置与此 RibbonComponent 关联的应用程序特定的数据。

public:
 property System::Object ^ Tag { System::Object ^ get(); void set(System::Object ^ value); };

public object Tag { get; set; }

member this.Tag : obj with get, set

Public Property Tag As Object

属性值

Object

一个 System.Object，表示与此 RibbonComponent关联的特定于应用程序的数据。

示例

以下示例演示如何将对象的数组 Employee 设置为 Tag 组的 属性，以及如何检索属性的值 Tag 。 此示例要求已定义一个名为 的 Employee 类，该类公开 String 属性 ID ，并且已定义返回 GetEmployees 对象数组 Employee 的方法。

若要运行此代码示例，必须先执行以下步骤：

1. 将功能区 (Visual Designer) 项添加到使用 Visual Studio 中的 Office 开发工具创建的项目中。

2. 将按钮添加到默认组 Group1。

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);
    }
}

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

注解

派生自 System.Object 类的任何类型都可以分配给此属性。 但是，如果在 Visual Studio“Tag属性”窗口中设置 属性，则只能分配文本。

属性的 Tag 一个常见用途是存储与 控件密切相关的数据。 例如，如果你有一个显示客户相关信息的按钮，则可以在按钮的 属性中存储 System.Data.DataSet 包含客户的订单历史记录的 Tag ，以便可以快速访问数据。