RibbonComponent.Tag Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets application-specific data that is associated with this 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
Property Value
An System.Object that represents application-specific data that is associated with this RibbonComponent.
Examples
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:
Add a Ribbon (Visual Designer) item to a project created by using Office development tools in Visual Studio.
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);
}
}
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
Remarks
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.