WebDisplayNameAttribute Constructors

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Initializes a new instance of the WebDisplayNameAttribute class.

Overloads

WebDisplayNameAttribute()	Initializes a new instance of the WebDisplayNameAttribute class without a specified name.
WebDisplayNameAttribute(String)	Initializes a new instance of the WebDisplayNameAttribute class with a specified display name.

WebDisplayNameAttribute()

Initializes a new instance of the WebDisplayNameAttribute class without a specified name.

public:
 WebDisplayNameAttribute();

public WebDisplayNameAttribute ();

Public Sub New ()

Remarks

The WebDisplayNameAttribute constructor sets the DisplayName property to an empty string ("").

WebDisplayNameAttribute(String)

Initializes a new instance of the WebDisplayNameAttribute class with a specified display name.

public:
 WebDisplayNameAttribute(System::String ^ displayName);

public WebDisplayNameAttribute (string displayName);

new System.Web.UI.WebControls.WebParts.WebDisplayNameAttribute : string -> System.Web.UI.WebControls.WebParts.WebDisplayNameAttribute

Public Sub New (displayName As String)

Parameters

displayName

String

The friendly name to use in a PropertyGridEditorPart.

Examples

The following code example demonstrates how to use the WebDisplayNameAttribute attribute to assign a display name to a property on a Web Parts control. The custom UserJobType property is given the friendly name "Job Type" to display in the PropertyGridEditorPart control. The name is assigned through the WebDisplayNameAttribute constructor. This example is part of a larger example found in the PropertyGridEditorPart class overview.

[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

Remarks

The WebDisplayNameAttribute constructor sets the DisplayName property to displayName. The displayName parameter is the value that will appear in a PropertyGridEditorPart control.