WebDescriptionAttribute クラスとは何？わかりやすく解説 Weblio辞書

.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

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

C++

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

/** @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

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