DisplayNameAttribute, classe (System.ComponentModel)

Changer de vue:
ScriptFree
Bibliothèque de classes .NET Framework
DisplayNameAttribute, classe
Cet article a fait l'objet d'une traduction manuelle. Pour afficher simultanément cette page et le contenu source en anglais, choisissez le paramètre d'affichage Basse densité.

Spécifie le nom complet pour une propriété, un événement ou une méthode void publique qui ne prend pas d'arguments.

Hiérarchie d'héritage

System.Object
  System.Attribute
    System.ComponentModel.DisplayNameAttribute

Espace de noms :  System.ComponentModel
Assembly :  System (dans System.dll)
Syntaxe

Visual Basic
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Event)> _
Public Class DisplayNameAttribute _
	Inherits Attribute
C#
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Event)]
public class DisplayNameAttribute : Attribute
VisualC++
[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Method|AttributeTargets::Property|AttributeTargets::Event)]
public ref class DisplayNameAttribute : public Attribute
F#
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Event)>]
type DisplayNameAttribute =  
    class
        inherit Attribute
    end

Le type DisplayNameAttribute expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique DisplayNameAttribute() Initialise une nouvelle instance de la classe DisplayNameAttribute.
Méthode publique DisplayNameAttribute(String) Initialise une nouvelle instance de la classe DisplayNameAttribute à l'aide du nom complet.
Début
Propriétés

  Nom Description
Propriété publique DisplayName Obtient le nom complet pour une propriété, un événement ou une méthode void publique qui ne prend pas d'arguments stockés dans cet attribut.
Propriété protégée DisplayNameValue Obtient ou définit le nom complet.
Propriété publique TypeId Lors de son implémentation dans une classe dérivée, obtient un identificateur unique pour Attribute. (Hérité de Attribute.)
Début
Méthodes

  Nom Description
Méthode publique Equals Détermine si deux instances de DisplayNameAttribute sont égales. (Substitue Attribute.Equals(Object).)
Méthode protégée Finalize Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de netto***ge avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
Méthode publique GetHashCode Retourne le code de hachage pour cette instance. (Substitue Attribute.GetHashCode().)
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique IsDefaultAttribute Détermine si cet attribut est l'attribut par défaut. (Substitue Attribute.IsDefaultAttribute().)
Méthode publique Match En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute.)
Méthode protégée MemberwiseClone Crée une copie superficielle de l'objet Object actif. (Hérité de Object.)
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
Début
Champs

  Nom Description
Champ public Membre statique Default Spécifie la valeur par défaut de DisplayNameAttribute. Ce champ est en lecture seule.
Début
Implémentations d'interface explicite

  Nom Description
Implémentation d'interface explicite Méthode privée _Attribute.GetIDsOfNames Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute.)
Implémentation d'interface explicite Méthode privée _Attribute.GetTypeInfo Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface. (Hérité de Attribute.)
Implémentation d'interface explicite Méthode privée _Attribute.GetTypeInfoCount Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute.)
Implémentation d'interface explicite Méthode privée _Attribute.Invoke Fournit l'accès aux propriétés et aux méthodes exposées par un objet. (Hérité de Attribute.)
Début
Notes

La valeur par défaut est celle de la propriété ou de l'événement. L'implémentation par défaut de GetSortedActionItems fait appel à la réflexion pour rechercher les propriétés publiques et les méthodes void publiques qui ne prennent pas d'arguments. GetSortedActionItems recherche DisplayNameAttribute sur chaque propriété et chaque méthode et, le cas échéant, utilise cette chaîne à la place du nom de propriété ou de méthode.

Exemples

L'exemple de code suivant montre l'utilisation de la classe DisplayNameAttribute pour remplacer le nom d'une propriété appelée MisnamedProperty par RenamedProperty dans un contrôle PropertyGrid. Pour obtenir l'intégralité du code, consultez Comment : appliquer des attributs dans les contrôles Windows Forms.

Visual Basic

' 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


C#

// 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;
    }
}


Informations de version

.NET Framework

Pris en charge dans : 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Pris en charge dans : 4, 3.5 SP1
Plateformes

Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.
Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.
Voir aussi

Référence