WebDisplayNameAttribute クラス

定義

public ref class WebDisplayNameAttribute : Attribute

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

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

Public Class WebDisplayNameAttribute
Inherits Attribute

継承

Object

Attribute

WebDisplayNameAttribute

属性

AttributeUsageAttribute

例

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

(WebDisplayName クラスの) WebDisplayNameAttribute属性を使用すると、編集 UI の各コントロールに表示されるラベルのテキストを指定できます。