This documentation is archived and is not being maintained.

WebDescriptionAttribute Constructor (String)

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

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

public WebDescriptionAttribute(
	string description
)

Parameters

description
Type: System.String
The ToolTip to use in a PropertyGridEditorPart.

The WebDescriptionAttribute constructor sets the Description property to description. The description parameter is the value that will appear as a ToolTip for a property in a PropertyGridEditorPart 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. The ToolTip is assigned through the WebDescriptionAttribute 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; }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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