WebDescriptionAttribute クラス
アセンブリ: System.Web (system.web.dll 内)

<AttributeUsageAttribute(AttributeTargets.Property)> _ Public Class WebDescriptionAttribute Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Property)] public class WebDescriptionAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Property)] public ref class WebDescriptionAttribute : public Attribute

PropertyGridEditorPart コントロールは、ユーザーが、WebPart のカスタム プロパティや WebPartZoneBase ゾーンに配置されるサーバー コントロールのカスタム プロパティを編集できるようにする汎用のユーザー インターフェイス (UI: User Interface) を提供します。編集 UI は、ソース コード内で WebBrowsableAttribute クラスの WebBrowsable 属性によってマークされるプロパティに対して提供されます。プロパティがこの属性によってマークされると、PropertyGridEditorPart コントロールは、プロパティの型に基づいて編集 UI を作成し、必要に応じて PropertyDescriptor オブジェクトを使用して、各編集コントロール内の値をプロパティの型に変換します。
WebDescriptionAttribute クラスの WebDescription 属性によって、編集 UI の各コントロールの上にマウス ポインタを置いたときに表示されるツールヒントを指定できます。

WebDescriptionAttribute 属性を使用して Web パーツ コントロールのプロパティにツールヒントを割り当てる方法のコード例を次に示します。カスタム UserJobType プロパティにツールヒント "ジョブに対応するカテゴリを選択します" を指定し、PropertyGridEditorPart コントロールに表示します。この例は PropertyGridEditorPart クラスの概要で取り上げているコード例の一部です。
<Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), _ WebDescription("Select the category that corresponds to your job.")> _ Public Property UserJobType() As JobTypeName Get Dim o As Object = ViewState("UserJobType") If Not (o Is Nothing) Then Return CType(o, JobTypeName) Else Return _userJobType End If End Get Set(ByVal value As JobTypeName) _userJobType = CType(value, JobTypeName) End Set End Property
[Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), WebDescription("Select the category that corresponds to your job.")] public JobTypeName UserJobType { get { object o = ViewState["UserJobType"]; if (o != null) return (JobTypeName)o; else return _userJobType; } set { _userJobType = (JobTypeName)value; } }


System.Attribute
System.Web.UI.WebControls.WebParts.WebDescriptionAttribute


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


WebDescriptionAttribute コンストラクタ ()
アセンブリ: System.Web (system.web.dll 内)


WebDescriptionAttribute コンストラクタは、Description プロパティに空の文字列 ("") を設定します。

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


WebDescriptionAttribute コンストラクタ (String)
アセンブリ: System.Web (system.web.dll 内)

Public Sub New ( _ description As String _ )
Dim description As String Dim instance As New WebDescriptionAttribute(description)
public WebDescriptionAttribute ( string description )
public: WebDescriptionAttribute ( String^ description )
public WebDescriptionAttribute ( String description )
public function WebDescriptionAttribute ( description : String )

WebDescriptionAttribute コンストラクタは、Description プロパティを description に設定します。description パラメータは、PropertyGridEditorPart コントロールのプロパティにツールヒントとして表示される値です。

WebDescriptionAttribute 属性を使用して Web パーツ コントロールのプロパティにツールヒントを割り当てる方法のコード例を次に示します。カスタム UserJobType プロパティにツールヒント "ジョブに対応するカテゴリを選択します" を指定し、PropertyGridEditorPart コントロールに表示します。ツールヒントは、WebDescriptionAttribute コンストラクタを通じて割り当てられます。この例は PropertyGridEditorPart クラスの概要で取り上げているコード例の一部です。
<Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), _ WebDescription("Select the category that corresponds to your job.")> _ Public Property UserJobType() As JobTypeName Get Dim o As Object = ViewState("UserJobType") If Not (o Is Nothing) Then Return CType(o, JobTypeName) Else Return _userJobType End If End Get Set(ByVal value As JobTypeName) _userJobType = CType(value, JobTypeName) End Set End Property
[Personalizable(), WebBrowsable(), WebDisplayName("Job Type"), WebDescription("Select the category that corresponds to your job.")] public JobTypeName UserJobType { get { object o = ViewState["UserJobType"]; if (o != null) return (JobTypeName)o; else return _userJobType; } set { _userJobType = (JobTypeName)value; } }

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


WebDescriptionAttribute コンストラクタ

名前 | 説明 |
---|---|
WebDescriptionAttribute () | WebDescriptionAttribute クラスの新しいインスタンスを初期化します。 |
WebDescriptionAttribute (String) | 指定された説明を使用して、WebDescriptionAttribute クラスの新しいインスタンスを初期化します。 |

WebDescriptionAttribute フィールド
WebDescriptionAttribute プロパティ

名前 | 説明 | |
---|---|---|
![]() | Description | PropertyGridEditorPart コントロールに表示するプロパティのツールヒントを取得します。 |
![]() | TypeId | 派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。) |


WebDescriptionAttribute メソッド

名前 | 説明 | |
---|---|---|
![]() | Equals | オーバーロードされます。 オーバーライドされます。 このインスタンスが、指定したオブジェクトに等しいかどうかを示す値を返します。 |
![]() | GetCustomAttribute | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。) |
![]() | GetCustomAttributes | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。) |
![]() | GetHashCode | オーバーライドされます。 表示名の値のハッシュ コードを返します。 |
![]() | GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) |
![]() | IsDefaultAttribute | オーバーライドされます。 現在のインスタンスが既定値に設定されているかどうかを判断します。 |
![]() | IsDefined | オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。) |
![]() | Match | 派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。) |
![]() | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) |
![]() | ToString | 現在の Object を表す String を返します。 ( Object から継承されます。) |

名前 | 説明 | |
---|---|---|
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) |
![]() | MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |

WebDescriptionAttribute メンバ
Web パーツ コントロールのプロパティのツールヒントとして使用する文字列値を定義します。
WebDescriptionAttribute データ型で公開されるメンバを以下の表に示します。



名前 | 説明 | |
---|---|---|
![]() | Description | PropertyGridEditorPart コントロールに表示するプロパティのツールヒントを取得します。 |
![]() | TypeId | 派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。) |


名前 | 説明 | |
---|---|---|
![]() | Equals | オーバーロードされます。 オーバーライドされます。 このインスタンスが、指定したオブジェクトに等しいかどうかを示す値を返します。 |
![]() | GetCustomAttribute | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。) |
![]() | GetCustomAttributes | オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。) |
![]() | GetHashCode | オーバーライドされます。 表示名の値のハッシュ コードを返します。 |
![]() | GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) |
![]() | IsDefaultAttribute | オーバーライドされます。 現在のインスタンスが既定値に設定されているかどうかを判断します。 |
![]() | IsDefined | オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。) |
![]() | Match | 派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。) |
![]() | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) |
![]() | ToString | 現在の Object を表す String を返します。 (Object から継承されます。) |

名前 | 説明 | |
---|---|---|
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
![]() | MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |

- WebDescriptionAttributeのページへのリンク