This topic has not yet been rated - Rate this topic

RibbonComponent.Tag Property

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Gets or sets application-specific data that is associated with this RibbonComponent.

Namespace:  Microsoft.Office.Tools.Ribbon
Assemblies:   Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)
  Microsoft.Office.Tools.Common.v4.0.Utilities (in Microsoft.Office.Tools.Common.v4.0.Utilities.dll)
Object Tag { get; set; }

Property Value

Type: System.Object
An System.Object that represents application-specific data that is associated with this RibbonComponent.

Any type derived from the System.Object class can be assigned to this property. However, if you set the Tag property in the Visual Studio Properties window, you can only assign text.

A common use for the Tag property is to store data that is closely associated with the control. For example, if you have a button that displays information about a customer, you might store a System.Data.DataSet that contains the customer's order history in the button's Tag property so the data can be accessed quickly.

The following example demonstrates how to set an array of Employee objects to the Tag property of a group and how to retrieve the value of the Tag property. This example requires that you have defined a class called Employee that exposes the String property ID and that you have defined a GetEmployees method that returns an array of Employee objects.

To run this code example, you must first perform the following steps:

  1. Add a Ribbon (Visual Designer) item to a project created by using Office development tools in Visual Studio.

  2. Add a button to the default group 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);
    }
}
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.