DisplayNameAttribute Class

Definition

Задает отображаемое имя свойства, события или открытого метода типа void, не принимающего аргументов.Specifies the display name for a property, event, or public void method which takes no arguments.

public ref class DisplayNameAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Event | System.AttributeTargets.Method | System.AttributeTargets.Property)]
public class DisplayNameAttribute : Attribute
public class DisplayNameAttribute : Attribute
type DisplayNameAttribute = class
    inherit Attribute
Public Class DisplayNameAttribute
Inherits Attribute
Inheritance
DisplayNameAttribute
Attributes

Examples

В следующем примере кода показано использование класса DisplayNameAttribute для изменения имени свойства с именем MisnamedProperty для RenamedProperty в элементе управления PropertyGrid.The following code example demonstrates using the DisplayNameAttribute class to change the name of a property called MisnamedProperty to RenamedProperty in a PropertyGrid control. Полный листинг кода см. в разделе практические руководства. Применение атрибутов в Windows Formsных элементах управления.For a full code listing, see 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 be appear as "RenamedProperty"
// instead of "MisnamedProperty".
[Description("Demonstrates DisplayNameAttribute.")]
[DisplayName("RenamedProperty")]
public bool MisnamedProperty
{
    get
    {
        return 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

Remarks

По умолчанию используется имя свойства или события.The default is the name of the property or event. Реализация GetSortedActionItems по умолчанию использует отражение для поиска открытых свойств и открытых методов void, не принимающих аргументов.The default implementation of GetSortedActionItems uses reflection to search the public properties and public void methods that take no arguments. GetSortedActionItems выполняет поиск DisplayNameAttribute в каждом свойстве и методе и, если он найден, использует эту строку вместо имени свойства или метода.GetSortedActionItems searches for the DisplayNameAttribute on each property and method and, if found, uses that string instead of the property or method name.

Constructors

DisplayNameAttribute()

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

DisplayNameAttribute(String)

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

Fields

Default

Определяет значение по умолчанию для атрибута DisplayNameAttribute.Specifies the default value for the DisplayNameAttribute. Это поле доступно только для чтения.This field is read-only.

Properties

DisplayName

Возвращает отображаемое имя для свойства, события или открытого метода типа void, не принимающего аргументов, хранящихся в этом атрибуте.Gets the display name for a property, event, or public void method that takes no arguments stored in this attribute.

DisplayNameValue

Возвращает или задает отображаемое имя.Gets or sets the display name.

TypeId

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

(Inherited from Attribute)

Methods

Equals(Object)

Определяет равенство двух экземпляров DisplayNameAttribute.Determines whether two DisplayNameAttribute instances are equal.

GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

GetType()

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

(Inherited from Object)
IsDefaultAttribute()

Определяет, является ли этот атрибут используемым по умолчанию.Determines if this attribute is the default.

IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

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

(Inherited from Attribute)
MemberwiseClone()

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

(Inherited from Object)
ToString()

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

(Inherited from Object)

Explicit Interface Implementations

_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)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.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)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (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)

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

(Inherited from Attribute)

Applies to

See also