DefaultValueAttribute-Klasse
Gibt den Standardwert für eine Eigenschaft an.
Namespace: System.ComponentModel
Assembly: System (in system.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.All)> _
Public Class DefaultValueAttribute
Inherits Attribute
'Usage
Dim instance As DefaultValueAttribute
[AttributeUsageAttribute(AttributeTargets.All)]
public class DefaultValueAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::All)]
public ref class DefaultValueAttribute : public Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All) */
public class DefaultValueAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All)
public class DefaultValueAttribute extends Attribute
Hinweise
Sie können DefaultValueAttribute mit einem beliebigen Wert erstellen. Der Standardwert eines Members wird i. d. R. als dessen Anfangswert verwendet. Ein visueller Designer kann den Wert des Members mit dem Standardwert zurücksetzen. Code-Generatoren können außerdem anhand des Standardwerts bestimmen, ob Code für den Member generiert werden soll.
Weitere Informationen finden Sie unter Übersicht über Attribute und Erweitern von Metadaten mithilfe von Attributen.
Beispiel
Im folgenden Beispiel wird der Standardwert von MyProperty auf false festgelegt.
Private MyVar as Boolean = False
<DefaultValue(False)> _
Public Property MyProperty() As Boolean
Get
Return MyVar
End Get
Set
MyVar = Value
End Set
End Property
private bool myVal=false;
[DefaultValue(false)]
public bool MyProperty {
get {
return myVal;
}
set {
myVal=value;
}
}
private:
bool myVal;
public:
[DefaultValue(false)]
property bool MyProperty
{
bool get()
{
return myVal;
}
void set( bool value )
{
myVal = value;
}
}
private boolean myVal = false;
/** @attribute DefaultValue(false)
*/
/** @property
*/
public boolean get_MyProperty()
{
return myVal;
} //get_MyProperty
/** @property
*/
public void set_MyProperty(boolean value)
{
myVal = value;
} //set_MyProperty
Im folgenden Beispiel wird der Standardwert von MyProperty überprüft. Zunächst wird im Code eine PropertyDescriptorCollection mit allen Eigenschaften für das Objekt abgerufen. Anschließend wird MyProperty über den Index in PropertyDescriptorCollection abgerufen. Die Attribute für diese Eigenschaft werden zurückgegeben und in der Variablen attributes gespeichert.
Im Beispiel erfolgt dann eine Ausgabe des Standardwerts auf dem Konsolenbildschirm, indem DefaultValueAttribute aus AttributeCollection abgerufen wird.
' 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()))
// 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.
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).
get_Item("MyProperty").get_Attributes();
/* Prints the default value by retrieving the DefaultValueAttribute
from the AttributeCollection.
*/
DefaultValueAttribute myAttribute = (DefaultValueAttribute)(attributes.
get_Item(DefaultValueAttribute.class.ToType()));
Console.WriteLine(("The default value is: "
+ myAttribute.get_Value().ToString()));
Vererbungshierarchie
System.Object
System.Attribute
System.ComponentModel.DefaultValueAttribute
Threadsicherheit
Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.
Plattformen
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.
Versionsinformationen
.NET Framework
Unterstützt in: 2.0, 1.1, 1.0
.NET Compact Framework
Unterstützt in: 2.0, 1.0
Siehe auch
Referenz
DefaultValueAttribute-Member
System.ComponentModel-Namespace
Attribute
PropertyDescriptor