DesignOnlyAttribute Klas

Definitie

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

Overname

Object

Attribute

DesignOnlyAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende voorbeeld wordt een GetLanguage eigenschap gemaakt. De eigenschap is gemarkeerd met een 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.
        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

In het volgende voorbeeld wordt de waarde van de DesignOnlyAttribute. Eerst krijgt de code een PropertyDescriptorCollection met alle eigenschappen voor het object. Vervolgens wordt deze geïndexeert in de PropertyDescriptorCollection eigenschap om de GetLanguage eigenschap te vinden. Vervolgens worden de kenmerken voor deze eigenschap geretourneerd en opgeslagen in de kenmerkvariabele.

In het voorbeeld wordt vervolgens afgedrukt of de eigenschap alleen is ontworpen door deze op te halen DesignOnlyAttribute en AttributeCollectionnaar het consolescherm te schrijven.

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

Opmerkingen

Leden die zijn gemarkeerd met de set waarop true deze DesignOnlyAttribute zijn ingesteld, kunnen alleen tijdens het ontwerp worden ingesteld. Deze eigenschappen bestaan doorgaans alleen tijdens het ontwerp en komen niet overeen met een echte eigenschap van het object tijdens runtime.

Leden die geen kenmerk hebben of zijn gemarkeerd met de DesignOnlyAttribute set waarop false deze is ingesteld, kunnen tijdens de runtime worden ingesteld. De standaardwaarde is false.

Een eigenschap met de set waarop true de DesignOnlyAttribute waarde is geserialiseerd in het RESX-bestand in plaats van de InitializeComponent methode.

Zie Kenmerken voor meer informatie.

Zie ook

• Attribute
• PropertyDescriptor