.NET Framework Class Library
AssemblyDescriptionAttribute Class

Provides a text description for an assembly.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ReflectionAssemblyDescriptionAttribute

Namespace:   System.Reflection
Assembly:  mscorlib (in mscorlib.dll)
Syntax
<[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/05bfs1hb_en-us_VS_110_2_0_0_0_1%].Assembly, Inherited := False)> _
<[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_0_0_2%](True)> _
Public NotInheritable Class AssemblyDescriptionAttribute _
	Inherits [%$TOPIC/05bfs1hb_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/05bfs1hb_en-us_VS_110_2_0_1_0_1%].Assembly, Inherited = false)]
[[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_1_0_2%](true)]
public sealed class AssemblyDescriptionAttribute : [%$TOPIC/05bfs1hb_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/05bfs1hb_en-us_VS_110_2_0_2_0_1%]::Assembly, Inherited = false)]
[[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_2_0_2%](true)]
public ref class AssemblyDescriptionAttribute sealed : public [%$TOPIC/05bfs1hb_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/05bfs1hb_en-us_VS_110_2_0_3_0_2%].Assembly, Inherited = false)>]
[<[%$TOPIC/05bfs1hb_en-us_VS_110_2_0_3_0_3%](true)>]
type AssemblyDescriptionAttribute =  
    class 
        inherit [%$TOPIC/05bfs1hb_en-us_VS_110_2_0_3_0_4%] 
    end

The AssemblyDescriptionAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps AssemblyDescriptionAttributeInitializes a new instance of the AssemblyDescriptionAttribute class.
Top
Properties
  NameDescription
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps DescriptionGets assembly description information.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps 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 Supported by the XNA Framework MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps 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

When you create a project in Microsoft Visual Studio 2005, this attribute is automatically applied with an empty string value. You can set its value in Visual Studio 2005 by selecting the Properties for the project from the File menu, and then by clicking Assembly Information. The attribute is saved in the AssemblyInfo file in your project, and it must be removed before you can specify it in code; otherwise, you will get an error that the attribute cannot be applied multiple times.

When you right-click the assembly file in File Explorer, this attribute appears as the Comments value on the Version tab of the file properties dialog box.

Examples

The following code example sets the AssemblyDescriptionAttribute for a simple assembly and indicates whether or not it was defined.

Imports System
Imports System.Reflection

<Assembly:AssemblyDescriptionAttribute("My Utility")> 

' Note: The suffix "Attribute" can be omitted: 
' <Assembly:AssemblyTitle("A title example")> 

Public Class Test
    Public Shared Sub Main()

        ' Get the assembly. 
        Dim asm As [Assembly] = [Assembly].GetCallingAssembly

        ' Verify that the description is applied. 
        Dim aType As Type = GetType(AssemblyDescriptionAttribute)

        Console.WriteLine("Description applied: {0}", _
            asm.IsDefined(aType, False))

    End Sub 
End Class 

' The output is: 
' Description Applied: True
using System;
using System.Reflection;

[assembly:AssemblyDescriptionAttribute("My Utility")]
public class Test {

    public static void Main() 
    {
        //  Get the assembly.
        Assembly asm = Assembly.GetCallingAssembly();

        //  Verify that the description is applied.
        Type aType = typeof(AssemblyDescriptionAttribute);
        Console.WriteLine("Description applied: {0}", 
            asm.IsDefined(aType, false));
    }
}
//  The output is: 
//  Description Applied: True
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
Platforms

Windows Phone 8.1, Windows Phone 8, 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.