DisplayNameAttribute Класс

Определение

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

System.ComponentModel

Сборки:

netstandard.dll, System.ComponentModel.Primitives.dll

Исходный код:

DisplayNameAttribute.cs

Указывает отображаемое имя свойства, события или метода public void, которое не принимает аргументов.

public ref class DisplayNameAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Event | System.AttributeTargets.Method | System.AttributeTargets.Property)]
public class DisplayNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Event | System.AttributeTargets.Method | System.AttributeTargets.Property)>]
type DisplayNameAttribute = class
    inherit Attribute

Public Class DisplayNameAttribute
Inherits Attribute

Наследование

Object

Attribute

DisplayNameAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода показано использование DisplayNameAttribute класса для изменения имени свойства, вызываемого MisnamedPropertyRenamedProperty в элементе PropertyGrid управления. Полный список кода см. в разделе How to: Apply Attributes in Windows Forms Controls.

// This property exists only to demonstrate the
// DisplayName attribute. When this control
// is attached to a PropertyGrid control, the
// property will appear as "RenamedProperty"
// instead of "MisnamedProperty".
[Description("Demonstrates DisplayNameAttribute.")]
[DisplayName("RenamedProperty")]
public bool MisnamedProperty => true;

' This property exists only to demonstrate the 
' DisplayName attribute. When this control 
' is attached to a PropertyGrid control, the
' property will be appear as "RenamedProperty"
' instead of "MisnamedProperty".
<Description("Demonstrates DisplayNameAttribute."), _
DisplayName("RenamedProperty")> _
Public ReadOnly Property MisnamedProperty() As Boolean
    Get
        Return True
    End Get
End Property

Комментарии

По умолчанию используется имя свойства или события. Реализация по умолчанию использует отражение для GetSortedActionItems поиска общедоступных свойств и методов public void, которые не принимают аргументов. GetSortedActionItems выполняет поиск по каждому свойству и методу DisplayNameAttribute , а при обнаружении использует ее вместо имени свойства или метода.

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

Имя	Описание
DisplayNameAttribute()	Инициализирует новый экземпляр класса DisplayNameAttribute.
DisplayNameAttribute(String)	Инициализирует новый экземпляр DisplayNameAttribute класса с помощью отображаемого имени.

Поля

Имя	Описание
Default	Указывает значение по умолчанию для параметра DisplayNameAttribute. Это поле доступно только для чтения.

Свойства

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

Методы

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

См. также раздел

• GetSortedActionItems()