DesignOnlyAttribute Class

Definition

Gibt an, ob eine Eigenschaft nur zur Entwurfszeit festgelegt werden kann.Specifies whether a property can only be set at design time.

public ref class DesignOnlyAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class DesignOnlyAttribute : Attribute
public sealed class DesignOnlyAttribute : Attribute
type DesignOnlyAttribute = class
    inherit Attribute
Public NotInheritable Class DesignOnlyAttribute
Inherits Attribute
Inheritance
DesignOnlyAttribute
Attributes

Examples

Im folgenden Beispiel wird eine GetLanguage-Eigenschaft erstellt.The following example creates a GetLanguage property. Die-Eigenschaft ist mit einem DesignOnlyAttributegekennzeichnet.The property is marked with a DesignOnlyAttribute.

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 des DesignOnlyAttributeabgerufen.The next example gets the value of the DesignOnlyAttribute. Zuerst erhält der Code eine PropertyDescriptorCollection mit allen Eigenschaften für das-Objekt.First the code gets a PropertyDescriptorCollection with all the properties for the object. Im nächsten Schritt wird der PropertyDescriptorCollection indiziert, um die GetLanguage-Eigenschaft zu suchen.Next it indexes into the PropertyDescriptorCollection to find the GetLanguage property. Anschließend werden die Attribute für diese Eigenschaft zurückgegeben und in der Attribut Variablen gespeichert.Then it returns the attributes for this property and saves them in the attributes variable.

Im Beispiel wird dann gedruckt, ob die Eigenschaft nur durch Abrufen DesignOnlyAttribute aus dem AttributeCollectionund durch das Schreiben auf den Konsolenbildschirm entworfen wird.The example then prints whether the property is design only by retrieving DesignOnlyAttribute from the AttributeCollection, and writing it to the console screen.

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

Remarks

Member, die mit dem auf true festgelegten DesignOnlyAttribute gekennzeichnet sind, können nur zur Entwurfszeit festgelegt werden.Members marked with the DesignOnlyAttribute set to true can be set only at design time. Diese Eigenschaften sind in der Regel nur zur Entwurfszeit vorhanden und entsprechen nicht der tatsächlichen Eigenschaft des Objekts zur Laufzeit.Typically, these properties exist only at design time and do not correspond to a real property on the object at run time.

Member, die entweder kein-Attribut haben oder mit dem DesignOnlyAttribute auf false gekennzeichnet sind, können während der Laufzeit festgelegt werden.Members that either have no attribute or are marked with the DesignOnlyAttribute set to false can be set during run time. Der Standardwert lautet false.The default is false.

Für eine Eigenschaft, bei der der DesignOnlyAttribute auf true festgelegt ist, wird der Wert in die RESX-Datei und nicht in die InitializeComponent-Methode serialisiert.A property with the DesignOnlyAttribute set to true has its value serialized to the .resx file instead of the InitializeComponent method.

Weitere Informationen finden Sie unter Attribute.For more information, see Attributes.

Constructors

DesignOnlyAttribute(Boolean)

Initialisiert eine neue Instanz der Klasse DesignOnlyAttribute.Initializes a new instance of the DesignOnlyAttribute class.

Fields

Default

Gibt den Standardwert für das DesignOnlyAttribute an, der No ist.Specifies the default value for the DesignOnlyAttribute, which is No. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

No

Gibt an, dass eine Eigenschaft zur Entwurfszeit oder zur Laufzeit festgelegt werden kann.Specifies that a property can be set at design time or at run time. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Yes

Gibt an, dass eine Eigenschaft nur zur Entwurfszeit festgelegt werden kann.Specifies that a property can be set only at design time. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Properties

IsDesignOnly

Ruft einen Wert ab, der angibt, ob eine Eigenschaft nur zur Entwurfszeit festgelegt werden kann.Gets a value indicating whether a property can be set only at design time.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Gibt zurück, ob der Wert des angegebenen Objekts gleich dem aktuellen DesignOnlyAttribute ist.Returns whether the value of the given object is equal to the current DesignOnlyAttribute.

GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Bestimmt, ob dieses Attribut der Standardwert ist.Determines if this attribute is the default.

IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also