DefaultValueAttribute Clase

Definición

public ref class DefaultValueAttribute : Attribute

public ref class DefaultValueAttribute sealed : Attribute

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

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

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

Public Class DefaultValueAttribute
Inherits Attribute

Public NotInheritable 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;
      }
   }

[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

En el ejemplo siguiente se comprueba el valor predeterminado de MyProperty. En primer lugar, el código obtiene un PropertyDescriptorCollection objeto con 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 desde 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 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.

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

Consulte también

• Attribute
• PropertyDescriptor