RibbonComponent.Tag, propriété

Article
08/10/2011

Obtient ou définit des données spécifiques à l'application associées à ce RibbonComponent.

Espace de noms : Microsoft.Office.Tools.Ribbon
Assembly : Microsoft.Office.Tools.Common (dans Microsoft.Office.Tools.Common.dll)

Syntaxe

'Déclaration
Property Tag As Object
    Get
    Set

Object Tag { get; set; }

Valeur de propriété

Type : System.Object
System.Object qui représente des données spécifiques à l'application associées à ce RibbonComponent.

Notes

Vous pouvez assigner n'importe quel type dérivé de la classe System.Object à cette propriété. Toutefois, si vous définissez la propriété Tag dans la fenêtre Propriétés de Visual Studio, vous pouvez assigner le texte uniquement.

La propriété Tag sert souvent à stocker des données étroitement associées au contrôle. Par exemple, si vous avez un bouton qui affiche des informations sur un client, vous pourriez stocker un System.Data.DataSet qui contient l'historique des commandes de ce client dans la propriété Tag de ce bouton afin d'accéder rapidement aux données.

Exemples

L'exemple suivant montre comment définir un tableau d'objets Employee pour la propriété Tag d'un groupe et comment extraire la valeur de la propriété Tag. Cet exemple exige que vous ayez défini à la fois une classe appelée Employee qui expose l'ID de la propriété String, ainsi qu'une méthode GetEmployees qui retourne un tableau d'objets Employee.

Pour exécuter cet exemple de code, vous devez exécuter tout d'abord les étapes suivantes :

Ajoutez un élément Ruban (Concepteur visuel) à un projet créé en utilisant les outils de développement Office dans Visual Studio.
Ajoutez un bouton au groupe par défaut 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);
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

RibbonComponent Interface

Microsoft.Office.Tools.Ribbon, espace de noms

Partager via