DefaultValueAttribute Klass

Definition

Namnområde:

System.ComponentModel

Sammansättning:

System.dll

Anger standardvärdet för en egenskap.

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

Arv

Object

Attribute

DefaultValueAttribute

Attribut

AttributeUsageAttribute

Exempel

I följande exempel anges standardvärdet MyProperty för till 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

I nästa exempel kontrolleras standardvärdet MyPropertyför . Först hämtar koden en PropertyDescriptorCollection med alla egenskaper för objektet. Därefter indexerar den till PropertyDescriptorCollection för att hämta MyProperty. Sedan returneras attributen för den här egenskapen och sparas i attributvariabeln.

Exemplet skriver sedan ut standardvärdet genom att DefaultValueAttribute hämta från AttributeCollection, och skriva dess namn till konsolskärmen.

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

Kommentarer

Du kan skapa en DefaultValueAttribute med valfritt värde. En medlems standardvärde är vanligtvis dess ursprungliga värde. En visuell designer kan använda standardvärdet för att återställa medlemmens värde. Kodgeneratorer kan också använda standardvärdena för att avgöra om koden ska genereras för medlemmen.

Note

En DefaultValueAttribute kommer inte att leda till att en medlem initieras automatiskt med attributets värde. Du måste ange det ursprungliga värdet i koden.

Mer information finns i Attribut.

Konstruktorer

Name	Description
DefaultValueAttribute(Boolean)	Initierar en ny instans av klassen med hjälp av DefaultValueAttribute ett Boolean värde.
DefaultValueAttribute(Byte)	Initierar en ny instans av DefaultValueAttribute klassen med ett 8-bitars osignerat heltal.
DefaultValueAttribute(Char)	Initierar en ny instans av DefaultValueAttribute klassen med ett Unicode-tecken.
DefaultValueAttribute(Double)	Initierar en ny instans av klassen med hjälp av DefaultValueAttribute ett flyttal med dubbel precision.
DefaultValueAttribute(Int16)	Initierar en ny instans av DefaultValueAttribute klassen med ett 16-bitars signerat heltal.
DefaultValueAttribute(Int32)	Initierar en ny instans av DefaultValueAttribute klassen med ett 32-bitars signerat heltal.
DefaultValueAttribute(Int64)	Initierar en ny instans av DefaultValueAttribute klassen med ett 64-bitars signerat heltal.
DefaultValueAttribute(Object)	Initierar en ny instans av DefaultValueAttribute klassen.
DefaultValueAttribute(Single)	Initierar en ny instans av klassen med hjälp av DefaultValueAttribute ett flyttal med enkel precision.
DefaultValueAttribute(String)	Initierar en ny instans av klassen med hjälp av DefaultValueAttribute en String.
DefaultValueAttribute(Type, String)	Initierar en ny instans av DefaultValueAttribute klassen, konverterar det angivna värdet till den angivna typen och använder en invariant kultur som översättningskontext.

Egenskaper

Name	Description
TypeId	När den implementeras i en härledd klass hämtar du en unik identifierare för den här Attribute. (Ärvd från Attribute)
Value	Hämtar standardvärdet för egenskapen som det här attributet är bundet till.

Metoder

Name	Description
Equals(Object)	Returnerar om värdet för det angivna objektet är lika med det aktuella DefaultValueAttribute.
GetHashCode()	Returnerar hash-koden för den här instansen.
GetType()	Hämtar den aktuella instansen Type . (Ärvd från Object)
IsDefaultAttribute()	När den åsidosättas i en härledd klass anger du om värdet för den här instansen är standardvärdet för den härledda klassen. (Ärvd från Attribute)
Match(Object)	När den åsidosätts i en härledd klass returneras ett värde som anger om den här instansen är lika med ett angivet objekt. (Ärvd från Attribute)
MemberwiseClone()	Skapar en ytlig kopia av den aktuella Object. (Ärvd från Object)
SetValue(Object)	Anger standardvärdet för egenskapen som det här attributet är bundet till.
ToString()	Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Object)

Explicita gränssnittsimplementeringar

Name	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mappar en uppsättning namn till en motsvarande uppsättning av sändningsidentifierare. (Ärvd från Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Hämtar typinformationen för ett objekt, som kan användas för att hämta typinformationen för ett gränssnitt. (Ärvd från Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Hämtar antalet typinformationsgränssnitt som ett objekt tillhandahåller (antingen 0 eller 1). (Ärvd från Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Ger åtkomst till egenskaper och metoder som exponeras av ett objekt. (Ärvd från Attribute)

Se även

• Attribute
• PropertyDescriptor