WebDescriptionAttribute Constructors

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Initializes a new instance of the WebDescriptionAttribute class.

Overloads

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

WebDescriptionAttribute()

Initializes a new instance of the WebDescriptionAttribute class.

public:
 WebDescriptionAttribute();

public WebDescriptionAttribute ();

Public Sub New ()

Remarks

The WebDescriptionAttribute constructor sets the Description property to an empty string ("").

WebDescriptionAttribute(String)

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

public:
 WebDescriptionAttribute(System::String ^ description);

public WebDescriptionAttribute (string description);

new System.Web.UI.WebControls.WebParts.WebDescriptionAttribute : string -> System.Web.UI.WebControls.WebParts.WebDescriptionAttribute

Public Sub New (description As String)

Parameters

description

String

The ToolTip to use in a PropertyGridEditorPart.

Examples

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

<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

Remarks

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.