WebDescriptionAttribute WebDescriptionAttribute WebDescriptionAttribute WebDescriptionAttribute Class

Определение

Определяет строковое значение, которое необходимо использовать в качестве всплывающей подсказки для свойства элемента управления веб-частей.Defines the string value to use as a ToolTip for a property of a Web Parts control.

public ref class WebDescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Property)]
public class WebDescriptionAttribute : Attribute
type WebDescriptionAttribute = class
    inherit Attribute
Public Class WebDescriptionAttribute
Inherits Attribute
Наследование
WebDescriptionAttributeWebDescriptionAttributeWebDescriptionAttributeWebDescriptionAttribute
Атрибуты

Примеры

В следующем примере кода демонстрируется использование WebDescriptionAttribute атрибут, чтобы назначить всплывающей подсказки к свойству элемента управления веб-частей.The following code example demonstrates how to use the WebDescriptionAttribute attribute to assign a ToolTip to a property on a Web Parts control. Пользовательский UserJobType свойства присваивается подсказку «Выберите категорию, соответствующую вашей работе».The custom UserJobType property is given the ToolTip "Select the category that corresponds to your job." для отображения в PropertyGridEditorPart элемента управления.to display in the PropertyGridEditorPart control. Этот пример является частью большого примера, приведенного в PropertyGridEditorPart Общие сведения о классе.This example is part of a larger example found in the PropertyGridEditorPart class overview.

[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 зоны.The PropertyGridEditorPart control provides a generic user interface (UI) that enables users to edit custom properties on WebPart and server controls placed in WebPartZoneBase zones. Пользовательский Интерфейс редактирования предоставляется для свойств, которые помечены в исходный код с WebBrowsable атрибут (из WebBrowsableAttribute класса).The editing UI is provided for properties that are marked in the source code with the WebBrowsable attribute (from the WebBrowsableAttribute class). Если свойство помечено атрибутом, PropertyGridEditorPart управления создает пользовательский Интерфейс редактирования на основе типа свойства и использует PropertyDescriptor объекта, если необходимо преобразовать значение в редактируемом элементе управления в тип свойства.When a property is marked with this attribute, a PropertyGridEditorPart control creates the editing UI based on the type of the property, and uses a PropertyDescriptor object if needed to convert the value in each editing control to the type of the property.

WebDescription Атрибут (из WebDescriptionAttribute класс) позволяет указать всплывающую подсказку, отображаемую с каждым элементом управления в пользовательском Интерфейсе редактирования, когда указатель мыши находится над элементом управления.The WebDescription attribute (from the WebDescriptionAttribute class) allows you to specify the ToolTip that appears with each control in the editing UI when the mouse pointer is positioned over the control.

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

WebDescriptionAttribute() WebDescriptionAttribute() WebDescriptionAttribute() WebDescriptionAttribute()

Инициализирует новый экземпляр класса WebDescriptionAttribute.Initializes a new instance of the WebDescriptionAttribute class.

WebDescriptionAttribute(String) WebDescriptionAttribute(String) WebDescriptionAttribute(String) WebDescriptionAttribute(String)

Инициализирует новый экземпляр класса WebDescriptionAttribute с заданным описанием.Initializes a new instance of the WebDescriptionAttribute class with the specified description.

Поля

Default Default Default Default

Представляет экземпляр класса WebDescriptionAttribute со свойством Description, для которого задано значение пустой строки ("").Represents an instance of the WebDescriptionAttribute class with the Description property set to an empty string ("").

Свойства

Description Description Description Description

Получает всплывающую подсказку для свойства, которую необходимо отобразить в элементе управления PropertyGridEditorPart.Gets the ToolTip for a property to display in a PropertyGridEditorPart control.

DescriptionValue DescriptionValue DescriptionValue DescriptionValue

Получает или задает всплывающую подсказку, которую необходимо отобразить в элементе управления PropertyGridEditorPart.Gets or sets the ToolTip to display in the PropertyGridEditorPart control.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код значения отображаемого имени.Returns the hash code for the display name value.

GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Определяет, задано ли для текущего экземпляра значение по умолчанию.Determines whether the current instance is set to the default value.

Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

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

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

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