RibbonComponent.Tag プロパティ

定義

名前空間:

Microsoft.Office.Tools.Ribbon

アセンブリ:

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

この 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

プロパティ値

Object

この RibbonComponentに関連付けられているアプリケーション固有のデータを表す System.Object。

例

次の例では、オブジェクトの配列をグループの Employee プロパティに設定する Tag 方法と、 プロパティの値を取得する方法を Tag 示します。 この例では、 プロパティIDを公開する というクラスEmployeeをString定義し、オブジェクトのEmployee配列をGetEmployees返すメソッドを定義している必要があります。

このコード例を実行するには、まず次の手順を実行する必要があります。

1. Visual Studio の Office 開発ツールを使用して作成したプロジェクトにリボン (Visual Designer) 項目を追加します。

2. 既定のグループ Group1にボタンを追加します。

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

注釈

クラスから派生した任意の型を System.Object このプロパティに割り当てることができます。 ただし、Visual Studio のTag [プロパティ] ウィンドウで プロパティを設定した場合は、テキストのみを割り当てることができます。

プロパティの一般的な Tag 用途は、コントロールに密接に関連付けられているデータを格納することです。 たとえば、顧客に関する情報を表示するボタンがある場合、データにすばやくアクセスできるように、顧客の注文履歴を含む をボタンのTagプロパティに格納System.Data.DataSetできます。