WebDescriptionAttribute

.NET Framework クラス ライブラリ リファレンス

WebDescriptionAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

Web パーツ コントロールのプロパティのツールヒントとして使用する文字列値を定義します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public Class WebDescriptionAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As WebDescriptionAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Property)] 
public class WebDescriptionAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
public ref class WebDescriptionAttribute :
 public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public class WebDescriptionAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
public class WebDescriptionAttribute extends
 Attribute

解説

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

WebDescriptionAttribute クラスの WebDescription 属性によって、編集 UI の各コントロールの上にマウス ポインタを置いたときに表示されるツールヒントを指定できます。

使用例

WebDescriptionAttribute 属性を使用して Web パーツ コントロールのプロパティにツールヒントを割り当てる方法のコード例を次に示します。カスタム UserJobType プロパティにツールヒント "ジョブに対応するカテゴリを選択します" を指定し、PropertyGridEditorPart コントロールに表示します。この例は PropertyGridEditorPart クラスの概要で取り上げているコード例の一部です。

Visual Basic

<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

C#

[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; }
}

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

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

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebDescriptionAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間

WebDescriptionAttribute コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

WebDescriptionAttribute クラスの新しいインスタンスを初期化します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New WebDescriptionAttribute

C#

public WebDescriptionAttribute ()

C++

public:
WebDescriptionAttribute ()

J#

public WebDescriptionAttribute ()

JScript

public function WebDescriptionAttribute ()

解説

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebDescriptionAttribute クラス
WebDescriptionAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間

WebDescriptionAttribute コンストラクタ (String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    description As String _
)

Visual Basic (使用法)

Dim description As String

Dim instance As New WebDescriptionAttribute(description)

C#

public WebDescriptionAttribute (
    string description
)

C++

public:
WebDescriptionAttribute (
    String^ description
)

J#

public WebDescriptionAttribute (
    String description
)

JScript

public function WebDescriptionAttribute (
    description : String
)

パラメータ

description

PropertyGridEditorPart で使用するツールヒント。

解説

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

使用例

WebDescriptionAttribute 属性を使用して Web パーツ コントロールのプロパティにツールヒントを割り当てる方法のコード例を次に示します。カスタム UserJobType プロパティにツールヒント "ジョブに対応するカテゴリを選択します" を指定し、PropertyGridEditorPart コントロールに表示します。ツールヒントは、WebDescriptionAttribute コンストラクタを通じて割り当てられます。この例は PropertyGridEditorPart クラスの概要で取り上げているコード例の一部です。

Visual Basic

<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

C#

[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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebDescriptionAttribute クラス
WebDescriptionAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間

WebDescriptionAttribute コンストラクタ

WebDescriptionAttribute クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

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

参照

関連項目

WebDescriptionAttribute クラス
WebDescriptionAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間

WebDescriptionAttribute フィールド

パブリック フィールド

	名前	説明
	Default	Description プロパティが空の文字列 ("") に設定された WebDescriptionAttribute クラスのインスタンスを表します。

参照

関連項目

WebDescriptionAttribute クラス
System.Web.UI.WebControls.WebParts 名前空間

WebDescriptionAttribute プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

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

プロテクト プロパティ

	名前	説明
	DescriptionValue	PropertyGridEditorPart コントロールに表示するツールヒントを取得または設定します。

参照

関連項目

WebDescriptionAttribute クラス
System.Web.UI.WebControls.WebParts 名前空間

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 クラス
System.Web.UI.WebControls.WebParts 名前空間

WebDescriptionAttribute メンバ

Web パーツ コントロールのプロパティのツールヒントとして使用する文字列値を定義します。

WebDescriptionAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	WebDescriptionAttribute	オーバーロードされます。 WebDescriptionAttribute クラスの新しいインスタンスを初期化します。

パブリック フィールド

	名前	説明
	Default	Description プロパティが空の文字列 ("") に設定された WebDescriptionAttribute クラスのインスタンスを表します。

パブリック プロパティ

( プロテクト プロパティ も参照)

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

プロテクト プロパティ

	名前	説明
	DescriptionValue	PropertyGridEditorPart コントロールに表示するツールヒントを取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	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 クラス
System.Web.UI.WebControls.WebParts 名前空間