Export (0) Print
Expand All

WebDisplayNameAttribute.WebDisplayNameAttribute(String) Constructor

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
)
public WebDisplayNameAttribute (
	String displayName
)
public function WebDisplayNameAttribute (
	displayName : String
)
Not applicable.

Parameters

displayName

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft