Windows フォームコントロールのプロパティの定義

2011-08-09

プロパティの概要については、「プロパティの概要」を参照してください。プロパティを定義する場合に考慮する必要がある点を次に示します。

定義するプロパティに属性を適用する必要があります。属性によって、デザイナーでのプロパティの表示形式が指定されます。詳細については、「コンポーネントのデザイン時属性」を参照してください。
プロパティの変更がコントロールのビジュアル表示に影響する場合は、set アクセサーから Invalidate メソッド (Control から継承されたメソッド) を呼び出します。すると、Invalidate によって、コントロールを再描画する OnPaint メソッドが呼び出されます。効率的な点から、Invalidate メソッドを複数回呼び出しても OnPaint が呼び出されるのは 1 回だけです。
.NET Framework クラスライブラリには、整数、10 進数、ブール値などの一般的なデータ型のための型コンバーターが用意されています。型コンバーターでは、一般に文字列を値へ変換する、つまり文字列データを他のデータ型に変換することが目的です。標準的なデータ型は既定の型コンバーターに関連付けられています。既定の型コンバーターでは、値から文字列への変換と、文字列から適切なデータ型への変換が行われます。カスタム (非標準) データ型のプロパティを定義する場合には、そのプロパティに関連付ける型コンバーターを指定する属性を適用する必要があります。属性を使用して、カスタム UI 型エディターをプロパティに関連付けることもできます。 UI 型エディターには、プロパティやデータ型を編集するためのユーザーインターフェイスが備わっています。カラーピッカーは、UI 型エディターの例です。属性の例については、このトピックの最後に示します。

注意

カスタムプロパティを処理できる型コンバーターまたは UI 型エディターがない場合には、「デザイン時サポートの拡張」の説明に従ってコンバーターまたはエディターを実装できます。

FlashTrackBar カスタムコントロールの EndColor というカスタムプロパティを定義するコード片を次に示します。

Public Class FlashTrackBar
   Inherits Control
   ...
   ' Private data member that backs the EndColor property.
   Private _endColor As Color = Color.LimeGreen

   ' The Category attribute tells the designer to display
   ' it in the Flash grouping. 
   ' The Description attribute provides a description of
   ' the property. 
   <Category("Flash"), _
   Description("The ending color of the bar.")>  _
   Public Property EndColor() As Color
      ' The public property EndColor accesses _endColor.
      Get
         Return _endColor
      End Get
      Set
         _endColor = value
         If Not (baseBackground Is Nothing) And showGradient Then
            baseBackground.Dispose()
            baseBackground = Nothing
         End If
         ' The Invalidate method calls the OnPaint method, which redraws  
         ' the control.
         Invalidate()
      End Set
   End Property
   ...
End Class

public class FlashTrackBar : Control {
   ...
   // Private data member that backs the EndColor property.
   private Color endColor = Color.LimeGreen;
   // The Category attribute tells the designer to display
   // it in the Flash grouping. 
   // The Description attribute provides a description of
   // the property. 
   [
   Category("Flash"),
   Description("The ending color of the bar.")
   ]
   // The public property EndColor accesses endColor.
   public Color EndColor {
      get {
         return endColor;
      }
      set {
         endColor = value;
         if (baseBackground != null && showGradient) {
            baseBackground.Dispose();
            baseBackground = null;
         }
         // The Invalidate method calls the OnPaint method, which redraws 
         // the control.
         Invalidate();
      }
   }
   ...
}

型コンバーターと UI 型エディターを Value プロパティに関連付けるコード片を次に示します。このコードでは、Value プロパティが整数であり、このプロパティには既定の型コンバーターが設定されていますが、TypeConverterAttribute 属性によってカスタム型コンバーター (FlashTrackBarValueConverter) が適用されます。これにより、デザイナーではこの Value プロパティがパーセントとして表示されます。 FlashTrackBarValueEditor UI 型エディターを使用すると、パーセント値が視覚的に表示されます。この例では、さらに TypeConverterAttribute 属性に指定された型コンバーターまたは EditorAttribute 属性に指定された型エディターが既定のコンバーターをオーバーライドします。

<Category("Flash"), _
TypeConverter(GetType(FlashTrackBarValueConverter)), _
Editor(GetType(FlashTrackBarValueEditor), _
GetType(UITypeEditor)), _
Description("The current value of the track bar.  You can enter an actual value or a percentage.")>  _
Public ReadOnly Property Value() As Integer
...
End Property

[
Category("Flash"), 
TypeConverter(typeof(FlashTrackBarValueConverter)),
Editor(typeof(FlashTrackBarValueEditor), typeof(UITypeEditor)),
Description("The current value of the track bar.  You can enter an actual value or a percentage.")
]
public int Value {
...
}

参照

概念

ShouldSerialize メソッドと Reset メソッドによる既定値の定義

プロパティ変更イベント

Windows フォームコントロールの属性

その他の技術情報

Windows フォームコントロールのプロパティ

次の方法で共有

Windows フォーム コントロールのプロパティの定義

参照

概念

その他の技術情報

その他のリソース

Windows フォームコントロールのプロパティの定義