WebDescriptionAttribute Класс

Определение

Пространство имен:

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

Определяет строковое значение, используемое в качестве подсказки для свойства элемента управления веб-частей.

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 атрибут для назначения подсказки свойству в элементе управления веб-частей. Настраиваемое 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 управления предоставляет универсальный пользовательский интерфейс, позволяющий пользователям изменять пользовательские свойства и WebPart серверные элементы управления, размещенные в WebPartZoneBase зонах. Пользовательский интерфейс редактирования предоставляется для свойств, помеченных в исходном коде атрибутом WebBrowsable (из WebBrowsableAttribute класса). Если свойство отмечено этим атрибутом, PropertyGridEditorPart элемент управления создает пользовательский интерфейс редактирования на основе типа свойства и при необходимости использует PropertyDescriptor объект для преобразования значения в каждом элементе управления редактирования в тип свойства.

Атрибут WebDescription (из WebDescriptionAttribute класса) позволяет указать подсказку, которая отображается с каждым элементом управления в пользовательском интерфейсе редактирования при расположении указателя мыши над элементом управления.

Конструкторы

Имя	Описание
WebDescriptionAttribute()	Инициализирует новый экземпляр класса WebDescriptionAttribute.
WebDescriptionAttribute(String)	Инициализирует новый экземпляр WebDescriptionAttribute класса с указанным описанием.

Поля

Имя	Описание
Default	Представляет экземпляр класса со свойством, WebDescriptionAttribute заданным для пустой Description строки ("").

Свойства

Имя	Описание
Description	Возвращает подсказку для свойства, отображаемого в элементе PropertyGridEditorPart управления.
DescriptionValue	Возвращает или задает подсказку для отображения в элементе PropertyGridEditorPart управления.
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.
GetHashCode()	Возвращает хэш-код для отображаемого значения имени.
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	Определяет, задан ли текущий экземпляр значением по умолчанию.
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Явные реализации интерфейса

Имя	Описание
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Извлекает сведения о типе объекта, который можно использовать для получения сведений о типе для интерфейса. (Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Предоставляет доступ к свойствам и методам, предоставляемым объектом. (Унаследовано от Attribute)