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 Sub New (
	description As String
)

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 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

.NET Framework
Available since 2.0
Return to top
Show: