RibbonComponent.Tag Eigenschaft

Definition

Ruft anwendungsspezifische Daten ab, die diesem RibbonComponent zugeordnet sind, oder legt diese fest.

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

Eigenschaftswert

Ein System.Object, das anwendungsspezifische Daten darstellt, die diesem RibbonComponentzugeordnet sind.

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie ein Array von Employee -Objekten auf die Tag -Eigenschaft einer Gruppe festgelegt und der Wert der Tag -Eigenschaft abgerufen wird. In diesem Beispiel müssen Sie eine Klasse namens Employee definiert haben, die die String -Eigenschaft ID verfügbar macht, und dass Sie eine GetEmployees Methode definiert haben, die ein Array von Employee -Objekten zurückgibt.

Um dieses Codebeispiel auszuführen, müssen Sie zunächst die folgenden Schritte ausführen:

  1. Fügen Sie ein Menübandelement (Visual Designer) zu einem Projekt hinzu, das mithilfe von Office-Entwicklungstools in Visual Studio erstellt wurde.

  2. Fügen Sie der Standardgruppe Group1eine Schaltfläche hinzu.

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

Hinweise

Dieser Eigenschaft kann jeder von der System.Object -Klasse abgeleitete Typ zugewiesen werden. Wenn Sie die Tag Eigenschaft jedoch im Fenster Eigenschaften von Visual Studio festlegen, können Sie nur Text zuweisen.

Eine häufige Verwendung für die Tag -Eigenschaft ist das Speichern von Daten, die eng mit dem Steuerelement verknüpft sind. Wenn Sie beispielsweise über eine Schaltfläche verfügen, die Informationen zu einem Kunden anzeigt, können Sie in der Eigenschaft der Schaltfläche Tag eine System.Data.DataSet speichern, die den Bestellverlauf des Kunden enthält, damit schnell auf die Daten zugegriffen werden kann.

Gilt für: