.NET Framework Class Library
WebDisplayNameAttribute Class

Defines the friendly name for a property of a Web Parts control.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.UI.WebControls.WebPartsWebDisplayNameAttribute

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
Syntax
<[%$TOPIC/ms157335_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms157335_en-us_VS_110_2_0_0_0_1%].Property)> _
Public Class WebDisplayNameAttribute _
	Inherits [%$TOPIC/ms157335_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/ms157335_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms157335_en-us_VS_110_2_0_1_0_1%].Property)]
public class WebDisplayNameAttribute : [%$TOPIC/ms157335_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/ms157335_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms157335_en-us_VS_110_2_0_2_0_1%]::Property)]
public ref class WebDisplayNameAttribute : public [%$TOPIC/ms157335_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/ms157335_en-us_VS_110_2_0_3_0_0%]([%$TOPIC/ms157335_en-us_VS_110_2_0_3_0_1%].Property)>]
type WebDisplayNameAttribute =  
    class 
        inherit [%$TOPIC/ms157335_en-us_VS_110_2_0_3_0_2%] 
    end
public class WebDisplayNameAttribute extends [%$TOPIC/ms157335_en-us_VS_110_2_0_4_0_0%]

The WebDisplayNameAttribute type exposes the following members.

Constructors
  NameDescription
Public method WebDisplayNameAttributeInitializes a new instance of the WebDisplayNameAttribute class without a specified name.
Public method WebDisplayNameAttribute(String)Initializes a new instance of the WebDisplayNameAttribute class with a specified display name.
Top
Properties
  NameDescription
Public property DisplayNameGets the name of a property to display in a PropertyGridEditorPart control.
Protected property DisplayNameValueGets or sets the name to display in the PropertyGridEditorPart control.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsReturns a value that indicates whether this instance is equal to a specified object. (Overrides AttributeEquals(Object).)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCodeReturns the hash code for the display name value. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeDetermines whether the current instance is set to the default value. (Overrides AttributeIsDefaultAttribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultRepresents an instance of the WebDisplayNameAttribute class with the DisplayName property set to an empty string ("").
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The PropertyGridEditorPart control provides a generic user interface (UI) that enables users to edit custom properties on WebPart and server controls placed in WebPartZoneBase zones. The editing UI is provided for properties that are marked in the source code with the WebBrowsable attribute (from the WebBrowsableAttribute class). When a property is marked with this attribute, a PropertyGridEditorPart control creates the editing UI based on the type of the property, and uses a PropertyDescriptor object if needed to convert the value in each editing control to the type of the property.

The WebDisplayName attribute (from the WebDisplayNameAttribute class) allows you to specify the text for the label that appears with each control in the editing UI.

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 a friendly name "Job Type" to display in the PropertyGridEditorPart control. 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 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
[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; }
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.