Control.Tag Control.Tag Control.Tag Control.Tag Property


コントロールに関するデータを格納するオブジェクトを取得または設定します。Gets or sets the object that contains data about the control.

 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


コントロールに関するデータを格納している ObjectAn Object that contains data about the control. 既定値は、null です。The default is null.

次のコード例では、フォームを表示Customerし、 Tagそのプロパティにを格納します。The following code example displays a form and stores a Customer in its Tag property. この例では、という名前Form CustomerFormのから派生し、をCustomer定義したクラスを定義している必要があります。This example requires that you have defined a class that derives from Form named CustomerForm and that you have defined a Customer.

   void buttonNewCustomer_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
      /* Create a new customer form and assign a new
                  * Customer object to the Tag property. */
      CustomerForm^ customerForm = gcnew CustomerForm;
      customerForm->Tag = gcnew Customer;
private void buttonNewCustomer_Click(object sender, EventArgs e)
   /* Create a new customer form and assign a new 
    * Customer object to the Tag property. */
   CustomerForm customerForm = new CustomerForm();
   customerForm.Tag = new Customer();
Private Sub buttonNewCustomer_Click(sender As Object, _
  e As EventArgs) Handles buttonNewCustomer.Click
   ' Create a new customer form and assign a new 
   ' Customer object to the Tag property. 
   Dim customerForm As New CustomerForm()
   customerForm.Tag = New Customer()
End Sub


Objectクラスから派生したすべての型をこのプロパティに割り当てることができます。Any type derived from the Object class can be assigned to this property. Windows フォームデザイナーを使用してプロパティが設定されている場合は、テキストのみを割り当てることができます。TagIf the Tag property is set through the Windows Forms designer, only text can be assigned.

Tagプロパティの一般的な用途は、コントロールに密接に関連付けられたデータを格納することです。A common use for the Tag property is to store data that is closely associated with the control. たとえば、顧客に関する情報を表示するコントロールがある場合、そのコントロールのDataSet Tagプロパティに顧客の注文履歴を含むを格納して、データにすばやくアクセスできるようにすることができます。For example, if you have a control that displays information about a customer, you might store a DataSet that contains the customer's order history in that control's Tag property so the data can be accessed quickly.