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.

No code example is currently available or this language may not be supported.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: