DescriptionAttribute Klasa

  • Odwołanie

Definicja

Przestrzeń nazw:
System.ComponentModel
Zestaw:
System.ComponentModel.Primitives.dll
Zestaw:
System.dll
Zestaw:
netstandard.dll

Określa opis właściwości lub zdarzenia.

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

Przykłady

W poniższym przykładzie zostanie utworzona MyImage właściwość . Właściwość ma dwa atrybuty: a DescriptionAttribute i .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.
       return 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

W następnym przykładzie zostanie przedstawiony opis elementu MyImage. Najpierw kod pobiera PropertyDescriptorCollection element ze wszystkimi właściwościami obiektu. Następnie indeksuje element , PropertyDescriptorCollection aby uzyskać MyImagewartość . Następnie zwraca atrybuty tej właściwości i zapisuje je w zmiennej atrybutów.

W tym przykładzie zostanie wyświetlony opis, pobierając DescriptionAttribute go z elementu AttributeCollection, i pisząc go na ekranie konsoli.

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

Uwagi

Projektant wizualizacji może wyświetlić określony opis podczas odwoływania się do elementu członkowskiego składnika, takiego jak w okno Właściwości. Wywołaj metodę Description uzyskiwania dostępu do wartości tego atrybutu.

Aby uzyskać więcej informacji, zobacz Atrybuty.

Konstruktory

DescriptionAttribute()

Inicjuje DescriptionAttribute nowe wystąpienie klasy bez parametrów.
DescriptionAttribute(String)

Inicjuje DescriptionAttribute nowe wystąpienie klasy z opisem.

Pola

Default

Określa wartość domyślną elementu DescriptionAttribute, który jest pustym ciągiem (""). To static pole jest tylko do odczytu.

Właściwości

Description

Pobiera opis przechowywany w tym atrybucie.
DescriptionValue

Pobiera lub ustawia ciąg przechowywany jako opis.
TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu .

(Odziedziczone po Attribute)

Metody

Equals(Object)

Zwraca, czy wartość danego obiektu jest równa bieżącej DescriptionAttributewartości .
GetHashCode()

Zwraca wartość skrótu dla tego wystąpienia.
GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
IsDefaultAttribute()

Zwraca wartość wskazującą, czy jest to wystąpienie domyślne DescriptionAttribute .
IsDefaultAttribute()

W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej.

(Odziedziczone po Attribute)
Match(Object)

Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi.

(Odziedziczone po Attribute)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Pobiera informacje o typie dla obiektu, który może służyć do pobierania informacji o typie dla interfejsu.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1).

(Odziedziczone po Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt.

(Odziedziczone po Attribute)

Dotyczy

Zobacz też