DefaultValueAttribute Klasse

Definition

Namespace:

System.ComponentModel

Assembly:

System.Runtime.dll

Quelle:

DefaultValueAttribute.cs

Gibt den Standardwert für eine Eigenschaft an.

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

Vererbung

Object

Attribute

DefaultValueAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird der Standardwert von MyProperty auf falsefestgelegt.

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

Im nächsten Beispiel wird der Standardwert von MyPropertyüberprüft. Zunächst ruft der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das -Objekt ab. Als Nächstes indiziert es in den PropertyDescriptorCollection , um abzurufen MyProperty. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Variablen attribute gespeichert.

Das Beispiel gibt dann den Standardwert aus, indem der DefaultValueAttribute von AttributeCollectionabgerufen und dessen Name in den Konsolenbildschirm geschrieben wird.

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

Hinweise

Sie können einen mit einem DefaultValueAttribute beliebigen Wert erstellen. Der Standardwert eines Members ist in der Regel sein Anfangswert. Ein visueller Designer kann den Standardwert verwenden, um den Wert des Elements zurückzusetzen. Codegeneratoren können die Standardwerte auch verwenden, um zu bestimmen, ob Code für das Element generiert werden soll.

Hinweis

A DefaultValueAttribute führt nicht dazu, dass ein Element automatisch mit dem Wert des Attributs initialisiert wird. Sie müssen den Anfangswert im Code festlegen.

Weitere Informationen finden Sie unter Attribute.

Konstruktoren

DefaultValueAttribute(Boolean)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung eines Boolean-Werts.
DefaultValueAttribute(Byte)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer vorzeichenlosen 8-Bit-Ganzzahl.
DefaultValueAttribute(Char)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung eines Unicode-Zeichens.
DefaultValueAttribute(Double)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer Gleitkommazahl mit doppelter Genauigkeit.
DefaultValueAttribute(Int16)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer 16-Bit-Ganzzahl mit Vorzeichen.
DefaultValueAttribute(Int32)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer 32-Bit-Ganzzahl mit Vorzeichen.
DefaultValueAttribute(Int64)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer 64-Bit-Ganzzahl mit Vorzeichen.
DefaultValueAttribute(Object)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse.
DefaultValueAttribute(SByte)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung eines SByte-Werts.
DefaultValueAttribute(Single)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer Gleitkommazahl mit einfacher Genauigkeit.
DefaultValueAttribute(String)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung einer String.
DefaultValueAttribute(Type, String)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse, wobei der angegebene Wert unter Verwendung einer invarianten Kultur als Übersetzungskontext in den angegebenen Typ konvertiert wird.
DefaultValueAttribute(UInt16)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung eines UInt16-Werts.
DefaultValueAttribute(UInt32)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung eines UInt32-Werts.
DefaultValueAttribute(UInt64)	Initialisiert eine neue Instanz der DefaultValueAttribute-Klasse unter Verwendung eines UInt64-Werts.

Eigenschaften

TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
Value	Ruft den Standardwert der Eigenschaft ab, an die dieses Attribut gebunden ist.

Methoden

Equals(Object)	Gibt zurück, ob der Wert des angegebenen Objekts gleich dem aktuellen DefaultValueAttribute ist.
GetHashCode()	Gibt den Hashcode für diese Instanz zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
SetValue(Object)	Legt den Standardwert der Eigenschaft fest, an die dieses Attribut gebunden ist.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Attribute
• PropertyDescriptor