WebPart.Description 属性

定义

获取或设置一条短语,该短语在部件控件的工具提示和目录中用来概述该部件控件的作用。

public:
 virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public override string Description { get; set; }
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.Description : string with get, set
Public Overrides Property Description As String

属性值

一个字符串,简要概述部件控件的功能。 默认值为空字符串 ("")。

实现

属性

注解

属性 Description 通常是一个字符串,用于提供部件控件列表的目录,并在部件控件的标题栏中用作工具提示。 将鼠标指针置于部件控件标题 Description 栏中的标题文本上时,属性的内容将显示在工具提示中。 工具提示文本由 属性的值 DisplayTitle 创建,后跟连字符,后跟 Description 属性值。

有关使用此属性的代码示例,请参阅基 Description 属性。

此属性的个性化设置范围设置为 Shared ,并且只能由授权用户修改。 有关详细信息,请参阅 PersonalizableAttributeWeb 部件个性化概述

适用于

另请参阅