DescriptionAttribute Třída

Reference

Definice

Obor názvů:: System.ComponentModel

Sestavení:: System.ComponentModel.Primitives.dll

Sestavení:: System.dll

Sestavení:: netstandard.dll

Zdroj:: DescriptionAttribute.cs

Zdroj:: DescriptionAttribute.cs

Zdroj:: DescriptionAttribute.cs

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Určuje popis vlastnosti nebo události.

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

Dědičnost: Object

Attribute
DescriptionAttribute

Odvozené: Microsoft.VisualBasic.Compatibility.VB6.SRDescriptionAttribute

System.Data.DataSysDescriptionAttribute

System.Diagnostics.MonitoringDescriptionAttribute

System.DirectoryServices.DSDescriptionAttribute

System.IO.IODescriptionAttribute

Více…

Atributy: AttributeUsageAttribute

Příklady

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

Další příklad získá popis .MyImage Nejprve kód získá objekt se PropertyDescriptorCollection všemi vlastnostmi objektu . Potom se indexuje do objektu , PropertyDescriptorCollection aby získal MyImage. Potom vrátí atributy pro tuto vlastnost a uloží je do proměnné attributes.

Příklad pak vytiskne popis načtením DescriptionAttribute z a zápisem na AttributeCollectionobrazovku 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 člen komponenty, například v okno Vlastnosti. Volání Description pro přístup k hodnotě tohoto atributu.

Další informace najdete v tématu Atributy.

Konstruktory

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

Pole

Default

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

Vlastnosti

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 tuto Attributetřídu . (Zděděno od Attribute)

Metody

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

Explicitní implementace rozhraní

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

Platí pro

Sdílet prostřednictvím