RibbonComponent.Tag Propriété

Référence

Définition

Espace de noms:: Microsoft.Office.Tools.Ribbon

Assemblys:: 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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Obtient ou définit des données propres à l’application associées à ce 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

Valeur de propriété

Object

Un System.Object qui représente des données propres à l’application associées à ce RibbonComponent.

Exemples

L’exemple suivant montre comment définir un tableau d’objets Employee sur la Tag propriété d’un groupe et comment récupérer la valeur de la Tag propriété. Cet exemple nécessite que vous ayez défini une classe appelée Employee qui expose la String propriété ID et que vous ayez défini une GetEmployees méthode qui retourne un tableau d’objets Employee .

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

Ajoutez un élément ruban (Visual Designer) à un projet créé à l’aide des outils de développement Office dans Visual Studio.
Ajoutez un bouton au groupe Group1par défaut .

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

Remarques

N’importe quel type dérivé de la System.Object classe peut être affecté à cette propriété. Toutefois, si vous définissez la Tag propriété dans la fenêtre Propriétés de Visual Studio, vous pouvez uniquement affecter du texte.

Une utilisation courante de la Tag propriété consiste à 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 pouvez stocker un System.Data.DataSet qui contient l’historique des commandes du client dans la propriété du Tag bouton afin que les données soient accessibles rapidement.

S’applique à

Partager via