WebDescriptionAttribute Class
Collapse the table of content
Expand the table of content

WebDescriptionAttribute Class


Defines the string value to use as a ToolTip for a property of a Web Parts control.

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


public class WebDescriptionAttribute : Attribute


Initializes a new instance of the WebDescriptionAttribute class.


Initializes a new instance of the WebDescriptionAttribute class with the specified description.


Gets the ToolTip for a property to display in a PropertyGridEditorPart control.


Gets or sets the ToolTip to display in the PropertyGridEditorPart control.


When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)


Returns a value that indicates whether this instance is equal to a specified object.(Overrides Attribute.Equals(Object).)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Returns the hash code for the display name value.(Overrides Attribute.GetHashCode().)


Gets the Type of the current instance.(Inherited from Object.)


Determines whether the current instance is set to the default value.(Overrides Attribute.IsDefaultAttribute().)


When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)


Represents an instance of the WebDescriptionAttribute class with the Description property set to an empty string ("").

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)


Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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 WebDescription attribute (from the WebDescriptionAttribute class) allows you to specify the ToolTip that appears with each control in the editing UI when the mouse pointer is positioned over the control.

The following code example demonstrates how to use the WebDescriptionAttribute attribute to assign a ToolTip to a property on a Web Parts control. The custom UserJobType property is given the ToolTip "Select the category that corresponds to your job." 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 JobTypeName UserJobType
    object o = ViewState["UserJobType"];
    if (o != null)
      return (JobTypeName)o;
      return _userJobType;

  set { _userJobType = (JobTypeName)value; }

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft