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)

Применяется к