次の方法で共有


プロパティの定義

プロパティについて知識が必要な場合は、「プロパティの概要」を参照してください。

PropertySample コントロールに Message という名前のプロパティを定義するコードを次に示します。

public class PropertySample : Control {
   private string  message;
   [Category("Text")]
   [Description("The message to display")]
   public string Message {
       get {
          return message;
       }
       set {
          message = value;
       }
   }
   ...
}
[Visual Basic]
Option Explicit
Option Strict

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.ComponentModel

Public Class PropertySample
   Inherits Control
   Private _message As String
   
   <Category("Text"), Description("The message to display")> _
   Public Property Message() As String
      Get
         Return _message
      End Get
      Set
         _message = value
      End Set
   End Property
   ...
End Class

プロパティを定義するときは、上のコードに示すように、1 つ以上の属性を使用して、プロパティのメタデータを指定してください。要素 Description("The message to display") は属性です。ビジュアル デザイナでコントロールを正しく表示するために、開発者は、プロパティの属性、イベントの属性、およびクラスの属性を使用して、デザイナにメタデータを提供する必要があります。属性について知識が必要な場合は、「コンポーネントのデザイン時属性」を参照してください。

**メモ   **このセクションで使用する "属性" という用語は、共通言語ランタイムまたはデザイン時ホストなどのツールの対象となるメタデータ属性を指します。メタデータ属性と、ASP.NET ページ構文で使用される XML や HTML の属性とを混同しないでください。

プロパティは、1 つのプリミティブ型またはクラス型、あるいはプリミティブ型のコレクションまたはクラス型のコレクションです。さまざまなプロパティの型については、「プロパティの型」で説明します。

メモ   この例で定義されているプロパティは、クライアントへのラウンド トリップ時に永続化されません。永続化されるプロパティを定義するには、「コントロールの状態の維持」で説明するように、ViewState プロパティを使用してプロパティ データを保持する必要があります。

参照

プロパティの型 | カスタム プロパティのサンプル