RibbonComponent.Tag プロパティ
この RibbonComponent と関連付けられたアプリケーション固有のデータを取得または設定します。
名前空間: Microsoft.Office.Tools.Ribbon
アセンブリ: Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll 内)
Microsoft.Office.Tools.Common.v4.0.Utilities (Microsoft.Office.Tools.Common.v4.0.Utilities.dll 内)
構文
'宣言
Property Tag As Object
Object Tag { get; set; }
プロパティ値
型 : System.Object
この RibbonComponent と関連付けられたアプリケーション固有のデータを表す System.Object。
解説
System.Object クラスから派生した任意の型をこのプロパティに割り当てることができます。ただし、Visual Studio の [プロパティ] ウィンドウで Tag プロパティを設定する場合は、割り当てることができるのはテキストのみです。
Tag プロパティは、一般的に、コントロールに密接に関連付けられたデータを格納するために使用します。たとえば、顧客に関する情報を表示するボタンがある場合は、顧客の注文履歴を含む System.Data.DataSet をボタンの Tag プロパティに格納して、データにすばやくアクセスできるようにします。
例
次の例では、Employee オブジェクトの配列を、グループの Tag プロパティに設定する方法と、Tag プロパティの値を取得する方法を示します。この例では、String プロパティである ID を公開する Employee というクラスを定義し、Employee オブジェクトの配列を返す GetEmployees メソッドを定義することが必要です。
このコード例を実行するには、最初に次の手順を実行する必要があります。
[リボン (ビジュアル デザイナー)] アイテムを、Visual Studio で Office 開発ツールを使用して作成されたプロジェクトに追加します。
ボタンを既定のグループ 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);
}
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。