WebDisplayNameAttribute Класс

Определение

Определяет понятное имя для свойства элемента управления веб-частей.Defines the friendly name for a property of a Web Parts control.

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

Примеры

В следующем примере кода показано, как использовать WebDisplayNameAttribute атрибут, чтобы присвоить отображаемое имя свойству элемента управления веб-части.The following code example demonstrates how to use the WebDisplayNameAttribute attribute to assign a display name to a property on a Web Parts control. Пользовательскому UserJobType свойству присваивается понятное имя "тип задания", которое отображается PropertyGridEditorPart в элементе управления.The custom UserJobType property is given a friendly name "Job Type" 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

Комментарии

Элемент управления предоставляет универсальный пользовательский интерфейс, позволяющий пользователям изменять пользовательские свойства в WebPart и серверных элементах управления, размещенных WebPartZoneBase в зонах. PropertyGridEditorPartThe 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.

WebDisplayName Атрибут (WebDisplayNameAttribute из класса) позволяет указать текст метки, которая отображается для каждого элемента управления в пользовательском интерфейсе редактирования.The WebDisplayName attribute (from the WebDisplayNameAttribute class) allows you to specify the text for the label that appears with each control in the editing UI.

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

WebDisplayNameAttribute()

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

WebDisplayNameAttribute(String)

Инициализирует новый экземпляр класса WebDisplayNameAttribute указанным отображаемым именем.Initializes a new instance of the WebDisplayNameAttribute class with a specified display name.

Поля

Default

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

Свойства

DisplayName

Получает имя свойства, отображаемое в элементе управления PropertyGridEditorPart.Gets the name of a property to display in a PropertyGridEditorPart control.

DisplayNameValue

Получает или задает имя, отображаемое в элементе управления PropertyGridEditorPart.Gets or sets the name to display in the PropertyGridEditorPart control.

TypeId

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

(Унаследовано от Attribute)

Методы

Equals(Object)

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

GetHashCode()

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

GetType()

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

(Унаследовано от Object)
IsDefaultAttribute()

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

Match(Object)

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

(Унаследовано от Attribute)
MemberwiseClone()

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

(Унаследовано от Object)
ToString()

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

(Унаследовано от Object)

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

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

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

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

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

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

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

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

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

(Унаследовано от Attribute)

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