DefaultValueAttribute Classe

Definição

Namespace:

System.ComponentModel

Assembly:

System.Runtime.dll

Origem:

DefaultValueAttribute.cs

Especifica o valor padrão de uma propriedade.

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

Herança

Object

Attribute

DefaultValueAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir define o valor padrão de MyProperty como 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

O exemplo a seguir verifica o valor padrão de MyProperty. Primeiro, o código obtém um PropertyDescriptorCollection com todas as propriedades do objeto . Em seguida, ele indexa no PropertyDescriptorCollection para obter MyProperty. Em seguida, ele retorna os atributos dessa propriedade e os salva na variável de atributos.

Em seguida, o exemplo imprime o valor padrão recuperando o DefaultValueAttribute do AttributeCollectione gravando seu nome na tela do 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()))

Comentários

Você pode criar um DefaultValueAttribute com qualquer valor. O valor padrão de um membro normalmente é seu valor inicial. Um designer visual pode usar o valor padrão para redefinir o valor do membro. Os geradores de código também podem usar os valores padrão para determinar se o código deve ser gerado para o membro.

Observação

Um DefaultValueAttribute não fará com que um membro seja inicializado automaticamente com o valor do atributo. Você deve definir o valor inicial em seu código.

Para obter mais informações, consulte Atributos.

Construtores

DefaultValueAttribute(Boolean)	Inicializa uma nova instância da classe DefaultValueAttribute usando um valor Boolean.
DefaultValueAttribute(Byte)	Inicializa uma nova instância da classe DefaultValueAttribute usando um inteiro sem sinal de 8 bits.
DefaultValueAttribute(Char)	Inicializa uma nova instância da classe DefaultValueAttribute usando um caractere Unicode.
DefaultValueAttribute(Double)	Inicializa uma nova instância da classe DefaultValueAttribute usando um número de ponto flutuante de precisão dupla.
DefaultValueAttribute(Int16)	Inicializa uma nova instância da classe DefaultValueAttribute usando um inteiro com sinal de 16 bits.
DefaultValueAttribute(Int32)	Inicializa uma nova instância da classe DefaultValueAttribute usando um inteiro com sinal de 32 bits.
DefaultValueAttribute(Int64)	Inicializa uma nova instância da classe DefaultValueAttribute usando um inteiro com sinal de 64 bits.
DefaultValueAttribute(Object)	Inicializa uma nova instância da classe DefaultValueAttribute.
DefaultValueAttribute(SByte)	Inicializa uma nova instância da classe DefaultValueAttribute usando um valor SByte.
DefaultValueAttribute(Single)	Inicializa uma nova instância da classe DefaultValueAttribute usando um número de ponto flutuante de precisão simples.
DefaultValueAttribute(String)	Inicializa uma nova instância da classe DefaultValueAttribute usando um String.
DefaultValueAttribute(Type, String)	Inicializa uma nova instância de classe DefaultValueAttribute, convertendo o valor especificado para o tipo especificado e usando uma cultura invariável como o contexto de translação.
DefaultValueAttribute(UInt16)	Inicializa uma nova instância da classe DefaultValueAttribute usando um valor UInt16.
DefaultValueAttribute(UInt32)	Inicializa uma nova instância da classe DefaultValueAttribute usando um valor UInt32.
DefaultValueAttribute(UInt64)	Inicializa uma nova instância da classe DefaultValueAttribute usando um valor UInt64.

Propriedades

TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)
Value	Obtém o valor padrão da propriedade à qual este atributo está associado.

Métodos

Equals(Object)	Retorna se o valor do objeto especificado é igual ao DefaultValueAttribute atual.
GetHashCode()	Retorna o código hash para a instância.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
SetValue(Object)	Define o valor padrão para a propriedade à qual este atributo está associado.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• Attribute
• PropertyDescriptor