DesignOnlyAttribute Klasse

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Quelle:

DesignOnlyAttribute.cs

Gibt an, ob eine Eigenschaft nur zur Entwurfszeit festgelegt werden kann.

public ref class DesignOnlyAttribute sealed : Attribute

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

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

Public NotInheritable Class DesignOnlyAttribute
Inherits Attribute

Vererbung

Object

Attribute

DesignOnlyAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird eine GetLanguage Eigenschaft erstellt. Die -Eigenschaft ist mit einem DesignOnlyAttributegekennzeichnet.

public:
   [DesignOnly(true)]
   property CultureInfo^ GetLanguage 
   {
      CultureInfo^ get()
      {
         // Insert code here.
         return myCultureInfo;
      }
      void set( CultureInfo^ value )
      {
         // Insert code here.
      }
   }

[DesignOnly(true)]
 public CultureInfo GetLanguage {
    get {
       // Insert code here.
       return myCultureInfo;
    }
    set {
       // Insert code here.
    }
 }

<DesignOnly(True)> _
Public Property GetLanguage() As CultureInfo
    Get
        ' Insert code here.
        Return myCultureInfo
    End Get
    Set
        ' Insert code here.
    End Set
End Property

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

Das Beispiel gibt dann aus, ob die Eigenschaft nur designt ist, indem von AttributeCollectionabgerufen DesignOnlyAttribute und in den Konsolenbildschirm geschrieben wird.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "GetLanguage" ]->Attributes;

/* Prints whether the property is marked as DesignOnly 
by retrieving the DesignOnlyAttribute from the AttributeCollection. */
DesignOnlyAttribute^ myAttribute = dynamic_cast<DesignOnlyAttribute^>(attributes[ DesignOnlyAttribute::typeid ]);
Console::WriteLine( "This property is design only :{0}", myAttribute->IsDesignOnly );

// Gets the attributes for the property.
 AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this)["GetLanguage"].Attributes;

 /* Prints whether the property is marked as DesignOnly 
  * by retrieving the DesignOnlyAttribute from the AttributeCollection. */
 DesignOnlyAttribute myAttribute = 
    (DesignOnlyAttribute)attributes[typeof(DesignOnlyAttribute)];
 Console.WriteLine("This property is design only :" +
    myAttribute.IsDesignOnly.ToString());

' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("GetLanguage").Attributes

' Prints whether the property is marked as DesignOnly 
' by retrieving the DesignOnlyAttribute from the AttributeCollection.
Dim myAttribute As DesignOnlyAttribute = _
    CType(attributes(GetType(DesignOnlyAttribute)), DesignOnlyAttribute)
Console.WriteLine(("This property is design only :" & _
    myAttribute.IsDesignOnly.ToString()))

Hinweise

Elemente, die mit der DesignOnlyAttribute Einstellung auf gekennzeichnet sind, true können nur zur Entwurfszeit festgelegt werden. In der Regel sind diese Eigenschaften nur zur Entwurfszeit vorhanden und entsprechen keiner realen Eigenschaft für das Objekt zur Laufzeit.

Member, die entweder über kein Attribut verfügen oder mit dem Satz auf gekennzeichnet sind, false können während der DesignOnlyAttribute Laufzeit festgelegt werden. Der Standardwert ist false.

Bei einer Eigenschaft, deren DesignOnlyAttribute Wert auf festgelegt ist, true wird der Wert in die RESX-Datei anstelle der InitializeComponent -Methode serialisiert.

Weitere Informationen finden Sie unter Attribute.

Konstruktoren

DesignOnlyAttribute(Boolean)

Initialisiert eine neue Instanz der DesignOnlyAttribute-Klasse.

Felder

Default	Gibt den Standardwert für das DesignOnlyAttribute an, der No ist. Dieses static-Feld ist schreibgeschützt.
No	Gibt an, dass eine Eigenschaft zur Entwurfszeit oder zur Laufzeit festgelegt werden kann. Dieses static-Feld ist schreibgeschützt.
Yes	Gibt an, dass eine Eigenschaft nur zur Entwurfszeit festgelegt werden kann. Dieses static-Feld ist schreibgeschützt.

Eigenschaften

IsDesignOnly	Ruft einen Wert ab, der angibt, ob eine Eigenschaft nur zur Entwurfszeit festgelegt werden kann.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt zurück, ob der Wert des angegebenen Objekts gleich dem aktuellen DesignOnlyAttribute ist.
GetHashCode()	Gibt den Hashcode für diese Instanz zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Bestimmt, ob dieses Attribut der Standardwert ist.
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)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Attribute
• PropertyDescriptor