AssemblyDescriptionAttribute Classe

Definição

Namespace:

System.Reflection

Assembly:

System.Runtime.dll

Origem:

AssemblyDescriptionAttribute.cs

Fornece uma descrição de texto para um assembly.

public ref class AssemblyDescriptionAttribute sealed : Attribute

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

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

Public NotInheritable Class AssemblyDescriptionAttribute
Inherits Attribute

Herança

Object

Attribute

AssemblyDescriptionAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir define o AssemblyDescriptionAttribute para um assembly simples e indica se ele foi definido ou não.

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

Comentários

Quando você cria um projeto no Microsoft Visual Studio 2005, esse atributo é aplicado automaticamente com um valor de cadeia de caracteres vazio. Você pode definir seu valor no Visual Studio 2005 selecionando as Propriedades do projeto no menu Arquivo e clicando em Informações do Assembly. O atributo é salvo no arquivo AssemblyInfo em seu projeto e deve ser removido antes que você possa especificá-lo no código; caso contrário, você receberá um erro de que o atributo não pode ser aplicado várias vezes.

Quando você clica com o botão direito do mouse no arquivo de assembly em Explorador de Arquivos, esse atributo aparece como o valor Comentários na guia Versão da caixa de diálogo propriedades do arquivo.

Construtores

AssemblyDescriptionAttribute(String)

Inicializa uma nova instância da classe AssemblyDescriptionAttribute.

Propriedades

Description	Obtém informações de descrição do assembly.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• Acessando atributos personalizados