DescriptionAttribute Třída

Definice

Obor názvů:

System.ComponentModel

Sestavení:

System.dll

Určuje popis vlastnosti nebo události.

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

Dědičnost

Object

Attribute

DescriptionAttribute

Odvozené

Microsoft.VisualBasic.Compatibility.VB6.SRDescriptionAttribute

System.Data.DataSysDescriptionAttribute

System.Diagnostics.MonitoringDescriptionAttribute

System.DirectoryServices.DSDescriptionAttribute

System.IO.IODescriptionAttribute

System.Messaging.MessagingDescriptionAttribute

System.ServiceProcess.ServiceProcessDescriptionAttribute

System.Timers.TimersDescriptionAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad vytvoří MyImage vlastnost. Vlastnost má dva atributy, a DescriptionAttribute a a 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

Další příklad získá popis .MyImage Nejprve kód získá PropertyDescriptorCollection všechny vlastnosti objektu. Dále indexuje do získání PropertyDescriptorCollectionMyImage. Pak vrátí atributy pro tuto vlastnost a uloží je do proměnné atributů.

Příklad pak vytiskne popis načtením DescriptionAttribute z objektu AttributeCollectiona jeho zápisem na obrazovku konzoly.

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

Poznámky

Vizuální návrhář může zobrazit zadaný popis při odkazování na člena komponenty, například v okno Vlastnosti. Volání Description pro přístup k hodnotě tohoto atributu

Další informace naleznete v tématu Atributy.

Konstruktory

Name	Description
DescriptionAttribute()	Inicializuje novou instanci DescriptionAttribute třídy bez parametrů.
DescriptionAttribute(String)	Inicializuje novou instanci DescriptionAttribute třídy s popisem.

Pole

Name	Description
Default	Určuje výchozí hodnotu pro DescriptionAttribute, což je prázdný řetězec (""). Toto static pole je jen pro čtení.

Vlastnosti

Name	Description
Description	Získá popis uložený v tomto atributu.
DescriptionValue	Získá nebo nastaví řetězec uložený jako popis.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí, zda hodnota daného objektu je rovna aktuální DescriptionAttribute.
GetHashCode()	Vrátí kód hash pro tuto instanci.
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Vrátí hodnotu určující, zda se jedná o výchozí DescriptionAttribute instanci.
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Explicitní implementace rozhraní

Name	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání. (Zděděno od Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Načte informace o typu objektu, který lze použít k získání informací o typu pro rozhraní. (Zděděno od Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1). (Zděděno od Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Poskytuje přístup k vlastnostem a metodám vystaveným objektem. (Zděděno od Attribute)

Viz také

• Attribute
• PropertyDescriptor
• EventDescriptor