This documentation is archived and is not being maintained.

WebDisplayNameAttribute Constructor (String)

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

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public WebDisplayNameAttribute(
	string displayName
)

Parameters

displayName
Type: System.String
The friendly name to use in a PropertyGridEditorPart.

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

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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: