DefaultValueAttribute Clase

Definición

Especifica el valor predeterminado de una propiedad.Specifies the default value for a property.

public ref class DefaultValueAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DefaultValueAttribute : Attribute
type DefaultValueAttribute = class
    inherit Attribute
Public Class DefaultValueAttribute
Inherits Attribute
Herencia
DefaultValueAttribute
Atributos

Ejemplos

En el ejemplo siguiente se establece el valor MyProperty predeterminado falsede en.The following example sets the default value of MyProperty to 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 MyPropertypredeterminado de.The next example checks the default value of MyProperty. En primer lugar, el PropertyDescriptorCollection código obtiene una con todas las propiedades del objeto.First the code gets a PropertyDescriptorCollection with all the properties for the object. A continuación, se indexa en PropertyDescriptorCollection el para MyPropertyobtener.Next it indexes into the PropertyDescriptorCollection to get MyProperty. A continuación, devuelve los atributos de esta propiedad y los guarda en la variable Attributes.Then it returns the attributes for this property and saves them in the attributes variable.

A continuación, el ejemplo imprime el valor predeterminado recuperando DefaultValueAttribute AttributeCollectionde y escribiendo su nombre en la pantalla de la consola.The example then prints the default value by retrieving the DefaultValueAttribute from the AttributeCollection, and writing its name to the console screen.

// 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 DefaultValueAttribute con cualquier valor.You can create a DefaultValueAttribute with any value. Normalmente, el valor predeterminado de un miembro es su valor inicial.A member's default value is typically its initial value. Un diseñador visual puede utilizar el valor predeterminado para restablecer el valor del miembro.A visual designer can use the default value to reset the member's value. Los generadores de código también pueden usar los valores predeterminados para determinar si se debe generar código para el miembro.Code generators can use the default values also to determine whether code should be generated for the member.

Nota

DefaultValueAttribute No hará que un miembro se inicialice automáticamente con el valor del atributo.A DefaultValueAttribute will not cause a member to be automatically initialized with the attribute's value. Debe establecer el valor inicial en el código.You must set the initial value in your code.

Para obtener más información, consulte Attributes (Atributos).For more information, see Attributes.

Constructores

DefaultValueAttribute(Boolean)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor Boolean.Initializes a new instance of the DefaultValueAttribute class using a Boolean value.

DefaultValueAttribute(Byte)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 8 bits sin signo.Initializes a new instance of the DefaultValueAttribute class using an 8-bit unsigned integer.

DefaultValueAttribute(Char)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un carácter Unicode.Initializes a new instance of the DefaultValueAttribute class using a Unicode character.

DefaultValueAttribute(Double)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un número de punto flotante de precisión doble.Initializes a new instance of the DefaultValueAttribute class using a double-precision floating point number.

DefaultValueAttribute(Int16)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 16 bits con signo.Initializes a new instance of the DefaultValueAttribute class using a 16-bit signed integer.

DefaultValueAttribute(Int32)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 32 bits con signo.Initializes a new instance of the DefaultValueAttribute class using a 32-bit signed integer.

DefaultValueAttribute(Int64)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un entero de 64 bits con signo.Initializes a new instance of the DefaultValueAttribute class using a 64-bit signed integer.

DefaultValueAttribute(Object)

Inicializa una nueva instancia de la clase DefaultValueAttribute.Initializes a new instance of the DefaultValueAttribute class.

DefaultValueAttribute(SByte)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor SByte.Initializes a new instance of the DefaultValueAttribute class using a SByte value.

DefaultValueAttribute(Single)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un número de punto flotante de precisión sencilla.Initializes a new instance of the DefaultValueAttribute class using a single-precision floating point number.

DefaultValueAttribute(String)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante String.Initializes a new instance of the DefaultValueAttribute class using a 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.Initializes a new instance of the DefaultValueAttribute class, converting the specified value to the specified type, and using an invariant culture as the translation context.

DefaultValueAttribute(UInt16)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor UInt16.Initializes a new instance of the DefaultValueAttribute class using a UInt16 value.

DefaultValueAttribute(UInt32)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor UInt32.Initializes a new instance of the DefaultValueAttribute class using a UInt32 value.

DefaultValueAttribute(UInt64)

Inicializa una nueva instancia de la clase DefaultValueAttribute mediante un valor UInt64.Initializes a new instance of the DefaultValueAttribute class using a UInt64 value.

Propiedades

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Heredado de Attribute)
Value

Obtiene el valor predeterminado de la propiedad a la que está enlazado este atributo.Gets the default value of the property this attribute is bound to.

Métodos

Equals(Object)

Devuelve un valor que indica si el valor del objeto especificado es igual al atributo DefaultValueAttribute actual.Returns whether the value of the given object is equal to the current DefaultValueAttribute.

GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
SetValue(Object)

Establece el valor predeterminado de la propiedad a la que está enlazado este atributo.Sets the default value for the property to which this attribute is bound.

ToString()

Devuelve un valor de tipo string que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Heredado de Attribute)

Se aplica a

Consulte también: