.NET Framework Class Library
DescriptionAttribute Class

Sets the description on an assembly (application), component, method, or interface. This class cannot be inherited.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.EnterpriseServicesDescriptionAttribute

Namespace:   System.EnterpriseServices
Assembly:  System.EnterpriseServices (in System.EnterpriseServices.dll)
Syntax
<[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_0%](False)> _
<[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_1%]([%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_2%].Assembly Or [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_3%].Class Or [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_4%].Method Or [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_5%].Interface, Inherited := True)> _
Public NotInheritable Class DescriptionAttribute _
	Inherits [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_0_0_6%]
[[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_0%](false)]
[[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_1%]([%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_2%].Assembly|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_3%].Class|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_4%].Method|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_5%].Interface, Inherited = true)]
public sealed class DescriptionAttribute : [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_1_0_6%]
[[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_0%](false)]
[[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_1%]([%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_2%]::Assembly|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_3%]::Class|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_4%]::Method|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_5%]::Interface, Inherited = true)]
public ref class DescriptionAttribute sealed : public [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_2_0_6%]
[<[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_1%](false)>]
[<[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_2%]([%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_3%].Assembly|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_4%].Class|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_5%].Method|[%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_6%].Interface, Inherited = true)>]
type DescriptionAttribute =  
    class 
        inherit [%$TOPIC/aax9ee5a_en-us_VS_110_2_0_3_0_7%] 
    end

The DescriptionAttribute type exposes the following members.

Constructors
  NameDescription
Public method DescriptionAttributeInitializes a new instance of the DescriptionAttribute class.
Top
Properties
  NameDescription
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

For more information about using attributes, see Extending Metadata Using Attributes.

Examples

The following code example demonstrates the use of this attribute.


<Assembly: Description("A system for ensuring that the correct account balance is stored after a transaction.")> 
[assembly: Description("A system for ensuring that the correct account balance is stored after a transaction.")]
[assembly: Description("A system for ensuring that the correct account " 
                       "balance is stored after a transaction.")];
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.