AssemblyDescriptionAttribute Classe

Definição

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

Herança

Object

Attribute

AssemblyDescriptionAttribute

Atributos

AttributeUsageAttribute ComVisibleAttribute

Exemplos

O exemplo de código seguinte define para AssemblyDescriptionAttribute uma assembly simples e indica se foi ou não definido.

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

Observações

Quando cria um projeto em Microsoft Visual Studio 2005, este atributo é automaticamente aplicado com um valor de string vazio. Pode definir o seu valor em Visual Studio 2005 selecionando o Properties do projeto no menu File, e depois clicando em Assembly Information. O atributo está guardado no ficheiro AssemblyInfo do seu projeto, e deve ser removido antes de o poder especificar em código; caso contrário, receberá um erro a indicar que o atributo não pode ser aplicado várias vezes.

Quando clica com o botão direito no ficheiro assembly no Explorador de Ficheiros, este atributo aparece como o valor Comentários no separador Versão da caixa de diálogo de propriedades do ficheiro.

Ver também

• Acessando atributos personalizados