DefaultValueAttribute Clase

Definición

Espacio de nombres:

System.ComponentModel

Ensamblado:

System.Runtime.dll

Source:

DefaultValueAttribute.cs

Especifica el valor predeterminado de una propiedad.

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

Herencia

Object

Attribute

DefaultValueAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente se establece el valor predeterminado de MyProperty en false.

private:
   bool _myVal;

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

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

private bool _myVal = false;

[DefaultValue(false)]
public bool MyProperty
{
    get
    {
        return _myVal;
    }
    set
    {
        _myVal = value;
    }
}

Private _myVar As Boolean = False

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

En el ejemplo siguiente se comprueba el valor predeterminado de MyProperty. En primer lugar, el código obtiene con PropertyDescriptorCollection todas las propiedades del objeto . A continuación, se indexa en para PropertyDescriptorCollection obtener MyProperty. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable attributes.

A continuación, el ejemplo imprime el valor predeterminado recuperando de DefaultValueAttributeAttributeCollectiony escribiendo su nombre en la pantalla de la consola.

// 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()))

Comentarios

Puede crear un objeto DefaultValueAttribute con cualquier valor. El valor predeterminado de un miembro suele ser su valor inicial. Un diseñador visual puede usar el valor predeterminado para restablecer el valor del miembro. Los generadores de código también pueden usar los valores predeterminados para determinar si se debe generar código para el miembro.

Nota

Un DefaultValueAttribute no hará que un miembro se inicialice automáticamente con el valor del atributo. Debe establecer el valor inicial en el código.

Para obtener más información, consulte Attributes (Atributos).

Constructores

DefaultValueAttribute(Boolean)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor Boolean.
DefaultValueAttribute(Byte)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 8 bits sin signo.
DefaultValueAttribute(Char)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un carácter Unicode.
DefaultValueAttribute(Double)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un número de punto flotante de precisión doble.
DefaultValueAttribute(Int16)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 16 bits con signo.
DefaultValueAttribute(Int32)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 32 bits con signo.
DefaultValueAttribute(Int64)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 64 bits con signo.
DefaultValueAttribute(Object)	Inicializa una nueva instancia de la clase DefaultValueAttribute.
DefaultValueAttribute(SByte)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor SByte.
DefaultValueAttribute(Single)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un número de punto flotante de precisión sencilla.
DefaultValueAttribute(String)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante String.
DefaultValueAttribute(Type, String)	Inicializa una nueva instancia de la clase DefaultValueAttribute, convirtiendo el valor especificado en el tipo especificado, y utilizando una referencia cultural invariable como contexto de conversión.
DefaultValueAttribute(UInt16)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor UInt16.
DefaultValueAttribute(UInt32)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor UInt32.
DefaultValueAttribute(UInt64)	Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor UInt64.

Propiedades

TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)
Value	Obtiene el valor predeterminado de la propiedad a la que está enlazado este atributo.

Métodos

Equals(Object)	Devuelve un valor que indica si el valor del objeto especificado es igual al atributo DefaultValueAttribute actual.
GetHashCode()	Devuelve el código hash de esta instancia.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
SetValue(Object)	Establece el valor predeterminado de la propiedad a la que está enlazado este atributo.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• Attribute
• PropertyDescriptor