Export (0) Print
Expand All

WebDescriptionAttribute Class

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

System.Object
  System.Attribute
    System.Web.UI.WebControls.WebParts.WebDescriptionAttribute

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

[AttributeUsageAttribute(AttributeTargets.Property)]
public class WebDescriptionAttribute : Attribute

The WebDescriptionAttribute type exposes the following members.

  NameDescription
Public methodWebDescriptionAttribute()Initializes a new instance of the WebDescriptionAttribute class.
Public methodWebDescriptionAttribute(String)Initializes a new instance of the WebDescriptionAttribute class with the specified description.
Top

  NameDescription
Public propertyDescriptionGets the ToolTip for a property to display in a PropertyGridEditorPart control.
Protected propertyDescriptionValueGets or sets the ToolTip to display in the PropertyGridEditorPart control.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsReturns a value that indicates whether this instance is equal to a specified object. (Overrides Attribute.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for the display name value. (Overrides Attribute.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeDetermines whether the current instance is set to the default value. (Overrides Attribute.IsDefaultAttribute().)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultRepresents an instance of the WebDescriptionAttribute class with the Description property set to an empty string ("").
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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
{
  get
  {
    object o = ViewState["UserJobType"];
    if (o != null)
      return (JobTypeName)o;
    else 
      return _userJobType;
  }

  set { _userJobType = (JobTypeName)value; }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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