DefaultValueAttribute Classe

Définition

Espace de noms:

System.ComponentModel

Assembly:

System.dll

Spécifie la valeur par défaut d’une propriété.

public ref class DefaultValueAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All)]
public class DefaultValueAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All)>]
type DefaultValueAttribute = class
    inherit Attribute

Public Class DefaultValueAttribute
Inherits Attribute

Héritage

Object

Attribute

DefaultValueAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant définit la valeur par défaut sur MyPropertyfalse.

private:
   bool _myVal;

public:
   [DefaultValue(false)]
   property bool MyProperty 
   {
      bool get()
      {
         return _myVal;
      }

      void set( bool value )
      {
         _myVal = value;
      }
   }

[DefaultValue(false)]
public bool MyProperty { get; set; }

Private _myVar As Boolean = False

<DefaultValue(False)>
Public Property MyProperty() As Boolean
    Get
        Return _myVar
    End Get
    Set
        _myVar = Value
    End Set
End Property

L’exemple suivant vérifie la valeur par défaut de MyProperty. Tout d’abord, le code obtient une PropertyDescriptorCollection valeur avec toutes les propriétés de l’objet. Ensuite, il indexe dans le PropertyDescriptorCollection fichier pour obtenir MyProperty. Ensuite, elle retourne les attributs de cette propriété et les enregistre dans la variable d’attributs.

L’exemple imprime ensuite la valeur par défaut en récupérant à DefaultValueAttribute partir du AttributeCollection, et en écrivant son nom dans l’écran de la console.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyProperty" ]->Attributes;

/* Prints the default value by retrieving the DefaultValueAttribute 
      * from the AttributeCollection. */
DefaultValueAttribute^ myAttribute = dynamic_cast<DefaultValueAttribute^>(attributes[ DefaultValueAttribute::typeid ]);
Console::WriteLine( "The default value is: {0}", myAttribute->Value );

// Gets the attributes for the property.
AttributeCollection attributes =
    TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;

/* Prints the default value by retrieving the DefaultValueAttribute
 * from the AttributeCollection. */
DefaultValueAttribute myAttribute =
    (DefaultValueAttribute)attributes[typeof(DefaultValueAttribute)];
Console.WriteLine("The default value is: " + myAttribute.Value.ToString());

' Gets the attributes for the property.
Dim attributes As AttributeCollection =
        TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Prints the default value by retrieving the DefaultValueAttribute
' from the AttributeCollection. 
Dim myAttribute As DefaultValueAttribute =
        CType(attributes(GetType(DefaultValueAttribute)), DefaultValueAttribute)
Console.WriteLine(("The default value is: " & myAttribute.Value.ToString()))

Remarques

Vous pouvez créer une DefaultValueAttribute valeur avec n’importe quelle valeur. La valeur par défaut d’un membre est généralement sa valeur initiale. Un concepteur visuel peut utiliser la valeur par défaut pour réinitialiser la valeur du membre. Les générateurs de code peuvent également utiliser les valeurs par défaut pour déterminer si le code doit être généré pour le membre.

Note

Un DefaultValueAttribute membre n’est pas automatiquement initialisé avec la valeur de l’attribut. Vous devez définir la valeur initiale dans votre code.

Pour plus d’informations, consultez Attributs.

Constructeurs

Nom	Description
DefaultValueAttribute(Boolean)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’une Boolean valeur.
DefaultValueAttribute(Byte)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un entier non signé 8 bits.
DefaultValueAttribute(Char)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un caractère Unicode.
DefaultValueAttribute(Double)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un nombre à virgule flottante double précision.
DefaultValueAttribute(Int16)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un entier signé 16 bits.
DefaultValueAttribute(Int32)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un entier signé 32 bits.
DefaultValueAttribute(Int64)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un entier signé 64 bits.
DefaultValueAttribute(Object)	Initialise une nouvelle instance de la classe DefaultValueAttribute.
DefaultValueAttribute(Single)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un nombre à virgule flottante simple précision.
DefaultValueAttribute(String)	Initialise une nouvelle instance de la classe à l’aide DefaultValueAttribute d’un String.
DefaultValueAttribute(Type, String)	Initialise une nouvelle instance de la DefaultValueAttribute classe, convertit la valeur spécifiée en type spécifié et utilise une culture invariante comme contexte de traduction.

Propriétés

Nom	Description
TypeId	En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute. (Hérité de Attribute)
Value	Obtient la valeur par défaut de la propriété à laquelle cet attribut est lié.

Méthodes

Nom	Description
Equals(Object)	Retourne si la valeur de l’objet donné est égale à la valeur actuelle DefaultValueAttribute.
GetHashCode()	Retourne le code de hachage pour cette instance.
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut de la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
SetValue(Object)	Définit la valeur par défaut de la propriété à laquelle cet attribut est lié.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

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

Voir aussi

• Attribute
• PropertyDescriptor