AssemblyDescriptionAttribute Class

Definition

public ref class AssemblyDescriptionAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)]
public sealed class AssemblyDescriptionAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false)]
public sealed class AssemblyDescriptionAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class AssemblyDescriptionAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)>]
type AssemblyDescriptionAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple=false)>]
type AssemblyDescriptionAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Assembly, Inherited=false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type AssemblyDescriptionAttribute = class
    inherit Attribute

Public NotInheritable Class AssemblyDescriptionAttribute
Inherits Attribute

Inheritance

Object

Attribute

AssemblyDescriptionAttribute

Attributes

AttributeUsageAttribute ComVisibleAttribute

Examples

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

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

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

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.

Constructors

Properties

Methods

Explicit Interface Implementations

Applies to

See also

• Accessing Custom Attributes