RibbonComponent.Tag (Propiedad)
Obtiene o establece los datos específicos de la aplicación que están asociados a este objeto RibbonComponent.
Espacio de nombres: Microsoft.Office.Tools.Ribbon
Ensamblado: Microsoft.Office.Tools.Common (en Microsoft.Office.Tools.Common.dll)
Sintaxis
'Declaración
Property Tag As Object
Get
Set
Object Tag { get; set; }
Valor de propiedad
Tipo: System.Object
System.Object que representa los datos específicos de la aplicación que están asociados a este objeto RibbonComponent.
Comentarios
A esta propiedad se le puede asignar cualquier tipo derivado de la clase System.Object. Sin embargo, si establece la propiedad Tag en la ventana Propiedades de Visual Studio, sólo podrá asignar texto.
Una uso muy común de la propiedad Tag es almacenar datos estrechamente relacionados con el control. Por ejemplo, si tiene un botón que muestra información sobre un cliente, puede almacenar un objeto System.Data.DataSet que contenga el historial de pedidos del cliente en la propiedad Tag del botón para poder obtener acceso rápido a los datos.
Ejemplos
En el ejemplo siguiente se muestra cómo establecer una matriz de los objetos Employee en la propiedad Tag de un grupo y cómo recuperar el valor de la propiedad Tag. El ejemplo requiere que haya definido una clase llamada Employee que exponga el identificador de la propiedad String y que haya definido un método GetEmployees que devuelva una matriz de objetos Employee.
Para poder ejecutar este ejemplo de código, primero debe seguir este procedimiento:
Agregue un elemento Cinta (diseñador visual) a un proyecto creado mediante las herramientas de desarrollo de Office en Visual Studio.
Agregue un botón al grupo predeterminado 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);
}
}
Seguridad de .NET Framework
- Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.