WebDescriptionAttribute 类

定义

public ref class WebDescriptionAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public class WebDescriptionAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type WebDescriptionAttribute = class
    inherit Attribute

Public Class WebDescriptionAttribute
Inherits Attribute

继承

Object

Attribute

WebDescriptionAttribute

属性

AttributeUsageAttribute

示例

下面的代码示例演示如何使用 WebDescriptionAttribute 特性将工具提示分配给 Web 部件控件上的属性。 为自定义 UserJobType 属性提供工具提示“选择与作业对应的类别”。要显示在控件中 PropertyGridEditorPart 。 此示例是类概述中找到的较大示例的 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

注解

该PropertyGridEditorPart控件提供了一个通用用户界面（UI），使用户可以编辑位于WebPart区域中的WebPartZoneBase自定义属性和服务器控件。 为源代码中 WebBrowsable 标记的属性（从 WebBrowsableAttribute 类）提供编辑 UI。 使用此属性标记属性时，控件 PropertyGridEditorPart 会基于属性的类型创建编辑 UI，并根据需要使用 PropertyDescriptor 对象将每个编辑控件中的值转换为属性的类型。

通过 WebDescription 属性（来自 WebDescriptionAttribute 类），可以在鼠标指针放置在控件上时，指定在编辑 UI 中随每个控件一起出现的工具提示。