WebDescriptionAttribute クラス

リファレンス

定義

名前空間:: System.Web.UI.WebControls.WebParts

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

public ref class WebDescriptionAttribute : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type WebDescriptionAttribute = class
    inherit Attribute

Public Class WebDescriptionAttribute
Inherits Attribute

継承: Object

Attribute
WebDescriptionAttribute

属性: AttributeUsageAttribute

例

次のコード例では、属性をWebDescriptionAttribute使用して、Web パーツコントロールのプロパティにツールヒントを割り当てる方法を示します。カスタム UserJobType プロパティには、"ジョブに対応するカテゴリを選択する" ツールヒントが指定されます。をクリックしてコントロールに表示します PropertyGridEditorPart 。この例は、クラスの概要で見つかったより大きな例の PropertyGridEditorPart 一部です。

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

<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

注釈

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

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

コンストラクター

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

フィールド

Default

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

プロパティ

Description	PropertyGridEditorPart コントロールに表示するプロパティのツールヒントを取得します。
DescriptionValue	PropertyGridEditorPart コントロールに表示するツールヒントを取得または設定します。
TypeId	派生クラスで実装されると、この Attribute の一意の識別子を取得します。 (継承元 Attribute)

メソッド

Equals(Object)	このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。
GetHashCode()	表示名値のハッシュコードを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	現在のインスタンスが既定値に設定されているかどうかを確認します。
Match(Object)	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	一連の名前を対応する一連のディスパッチ識別子に割り当てます。 (継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。 (継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。 (継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。 (継承元 Attribute)

適用対象