Export (0) Print
Expand All

WebDisplayNameAttribute Constructor (String)

Note: This constructor is new in the .NET Framework version 2.0.

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
)

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 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft