RibbonComponent.Tag Propiedad

Definición

Espacio de nombres:

Microsoft.Office.Tools.Ribbon

Ensamblados:

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

Obtiene o establece los datos específicos de la aplicación que están asociados a este objeto 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

Valor de propiedad

Object

Objeto System.Object que representa datos específicos de la aplicación asociados a este RibbonComponentobjeto .

Ejemplos

En el ejemplo siguiente se muestra cómo establecer una matriz de Employee objetos en la Tag propiedad de un grupo y cómo recuperar el valor de la Tag propiedad . En este ejemplo se requiere que haya definido una clase denominada Employee que exponga la String propiedad ID y que haya definido un GetEmployees método que devuelva una matriz de Employee objetos.

Para ejecutar este ejemplo de código, primero debe realizar los pasos siguientes:

1. Agregue un elemento de cinta de opciones (Visual Designer) a un proyecto creado mediante herramientas de desarrollo de Office en Visual Studio.

2. Agregue un botón al grupo Group1predeterminado.

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

Comentarios

Cualquier tipo derivado de la System.Object clase se puede asignar a esta propiedad. Sin embargo, si establece la Tag propiedad en la ventana Propiedades de Visual Studio, solo puede asignar texto.

Un uso común de la Tag propiedad es almacenar datos que están estrechamente asociados con el control. Por ejemplo, si tiene un botón que muestra información sobre un cliente, puede almacenar un System.Data.DataSet que contenga el historial de pedidos del cliente en la propiedad del Tag botón para que se pueda acceder a los datos rápidamente.