WebDescriptionAttribute 构造函数

定义

命名空间:

System.Web.UI.WebControls.WebParts

程序集:

System.Web.dll

初始化 WebDescriptionAttribute 类的新实例。

重载

WebDescriptionAttribute()	初始化 WebDescriptionAttribute 类的新实例。
WebDescriptionAttribute(String)	使用指定的说明初始化 WebDescriptionAttribute 类的新实例。

WebDescriptionAttribute()

初始化 WebDescriptionAttribute 类的新实例。

public:
 WebDescriptionAttribute();

public WebDescriptionAttribute ();

Public Sub New ()

注解

构造 WebDescriptionAttribute 函数将 Description 属性设置为空字符串 (“”) 。

WebDescriptionAttribute(String)

使用指定的说明初始化 WebDescriptionAttribute 类的新实例。

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)

参数

description

String

要在 PropertyGridEditorPart 中使用的工具提示。

示例

下面的代码示例演示如何使用WebDescriptionAttribute属性将工具提示分配给Web 部件控件上的属性。 自定义 UserJobType 属性提供工具提示“选择与作业对应的类别”。 在控件中 PropertyGridEditorPart 显示。 工具提示是通过构造函数分配的 WebDescriptionAttribute 。 此示例是类概述中找到的较大示例的 PropertyGridEditorPart 一部分。

[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

注解

构造 WebDescriptionAttribute 函数将 Description 属性设置为 description. 该 description 参数是将作为控件中 PropertyGridEditorPart 属性的工具提示显示的值。