DescriptionAttribute Klas

Definitie

Naamruimte:
System.ComponentModel
Assembly:
System.dll
Assembly:
netstandard.dll

Specificeert een beschrijving voor een eigenschap of gebeurtenis.

public ref class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
Overname
Object
Attribute
DescriptionAttribute
Afgeleid
Kenmerken
AttributeUsageAttribute

Voorbeelden

In het volgende voorbeeld wordt de MyImage eigenschap gemaakt. De eigenschap heeft twee kenmerken, een DescriptionAttribute en een CategoryAttribute.

public:
   property Image^ MyImage 
   {
      [Description("The image associated with the control"),Category("Appearance")]
      Image^ get()
      {
         // Insert code here.
         return image1;
      }

      void set( Image^ value )
      {
         // Insert code here.
      }
   }

[Description("The image associated with the control"), Category("Appearance")]
public Image MyImage
{
    get =>
        // Insert code here.
        image1;
    set
    {
        // Insert code here.
    }
}

<Description("The image associated with the control"), _
    Category("Appearance")> _
Public Property MyImage() As Image
    Get
        ' Insert code here.
        Return image1
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

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

In het voorbeeld wordt vervolgens de beschrijving afgedrukt door deze op te DescriptionAttribute halen en AttributeCollectionnaar het consolescherm te schrijven.

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

/* Prints the description by retrieving the DescriptionAttribute 
      * from the AttributeCollection. */
DescriptionAttribute^ myAttribute = dynamic_cast<DescriptionAttribute^>(attributes[ DescriptionAttribute::typeid ]);
Console::WriteLine( myAttribute->Description );

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

/* Prints the description by retrieving the DescriptionAttribute 
 * from the AttributeCollection. */
DescriptionAttribute myAttribute =
   (DescriptionAttribute)attributes[typeof(DescriptionAttribute)];
Console.WriteLine(myAttribute.Description);

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

' Prints the description by retrieving the DescriptionAttribute
' from the AttributeCollection. 
Dim myAttribute As DescriptionAttribute = _
    CType(attributes(GetType(DescriptionAttribute)), DescriptionAttribute)
Console.WriteLine(myAttribute.Description)

Opmerkingen

Een visuele ontwerper kan de opgegeven beschrijving weergeven bij het verwijzen naar het onderdeellid, zoals in een venster Eigenschappen. Aanroep Description om toegang te krijgen tot de waarde van dit kenmerk.

Zie Kenmerken voor meer informatie.

Constructors

Name Description
DescriptionAttribute()

Initialiseert een nieuw exemplaar van de DescriptionAttribute klasse zonder parameters.
DescriptionAttribute(String)

Initialiseert een nieuw exemplaar van de DescriptionAttribute klasse met een beschrijving.

Velden

Name Description
Default

Hiermee geeft u de standaardwaarde voor de DescriptionAttribute, een lege tekenreeks (""). Dit static veld heeft het kenmerk Alleen-lezen.

Eigenschappen

Name Description
Description

Hiermee haalt u de beschrijving op die in dit kenmerk is opgeslagen.
DescriptionValue

Hiermee haalt u de tekenreeks op die als beschrijving is opgeslagen of stelt u deze in.
TypeId

Wanneer deze wordt geïmplementeerd in een afgeleide klasse, krijgt u Attributehiervoor een unieke id.

(Overgenomen van Attribute)

Methoden

Name Description
Equals(Object)

Geeft als resultaat of de waarde van het opgegeven object gelijk is aan de huidige DescriptionAttribute.
GetHashCode()

Retourneert de hash-code voor dit exemplaar.
GetType()

Hiermee haalt u de Type huidige instantie op.

(Overgenomen van Object)
IsDefaultAttribute()

Retourneert een waarde die aangeeft of dit het standaardexemplaren DescriptionAttribute is.
IsDefaultAttribute()

Wanneer deze wordt overschreven in een afgeleide klasse, geeft u aan of de waarde van dit exemplaar de standaardwaarde is voor de afgeleide klasse.

(Overgenomen van Attribute)
Match(Object)

Wanneer deze wordt overschreven in een afgeleide klasse, wordt een waarde geretourneerd die aangeeft of dit exemplaar gelijk is aan een opgegeven object.

(Overgenomen van Attribute)
MemberwiseClone()

Hiermee maakt u een ondiepe kopie van de huidige Object.

(Overgenomen van Object)
ToString()

Retourneert een tekenreeks die het huidige object vertegenwoordigt.

(Overgenomen van Object)

Expliciete interface-implementaties

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

Hiermee wordt een set namen toegewezen aan een bijbehorende set verzend-id's.

(Overgenomen van Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Hiermee haalt u de typegegevens voor een object op, die kan worden gebruikt om de typegegevens voor een interface op te halen.

(Overgenomen van Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Hiermee wordt het aantal type-informatieinterfaces opgehaald dat een object biedt (0 of 1).

(Overgenomen van Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Biedt toegang tot eigenschappen en methoden die door een object worden weergegeven.

(Overgenomen van Attribute)

Van toepassing op

Zie ook