CLSCompliantAttribute Classe

Definição

Namespace:
System
Assemblies:
mscorlib.dll, System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
System.Runtime.dll
Assembly:
netstandard.dll

Indica se um elemento de programa está em conformidade com a Especificação de Linguagem Comum (CLS). Essa classe não pode ser herdada.

public ref class CLSCompliantAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
public sealed class CLSCompliantAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
[System.Serializable]
public sealed class CLSCompliantAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class CLSCompliantAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)>]
type CLSCompliantAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)>]
[<System.Serializable>]
type CLSCompliantAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=false, Inherited=true)>]
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type CLSCompliantAttribute = class
    inherit Attribute
Public NotInheritable Class CLSCompliantAttribute
Inherits Attribute
Herança
Object
Attribute
CLSCompliantAttribute
Atributos
AttributeUsageAttribute SerializableAttribute ComVisibleAttribute

Exemplos

O exemplo a seguir aplica-se a todo CLSCompliantAttribute o assembly.

using System;
    [assembly: CLSCompliant(true)]

A declaração a seguir gera um aviso de conformidade com CLS porque o tipo UInt32 não é especificado no CLS.

public int SetValue(UInt32 value);

Se a declaração estiver marcada com um CLSCompliantAttributeerro ou aviso de compilador, nenhum erro será gerado.

[CLSCompliant(false)]
 public int SetValue(UInt32 value);

Comentários

O atributo CLSCompliantAttribute é usado para indicar se um determinado elemento de programa está em conformidade com a CLS (Common Language Specification), que define os recursos que qualquer linguagem direcionada .NET deve dar suporte. A conformidade com CLS é principalmente preocupante para os desenvolvedores de biblioteca que desejam garantir que suas bibliotecas estejam acessíveis em qualquer idioma direcionado .NET. Para obter mais informações, consulte independência de idioma e componentes de Language-Independent.

Você pode aplicar o CLSCompliantAttribute atributo aos seguintes elementos de programa: assembly, módulo, classe, struct, enum, construtor, método, propriedade, campo, evento, interface, delegado, parâmetro e valor retornado. No entanto, a noção de conformidade com CLS só é significativa para assemblies, módulos, tipos e membros de tipos, não partes de uma assinatura de membro. Consequentemente, CLSCompliantAttribute é ignorado quando aplicado a elementos de programa de parâmetro ou valor retornado.

Se não CLSCompliantAttribute for aplicado a um elemento de programa, por padrão:

  • O assembly não é compatível com CLS.

  • O tipo só será compatível com CLS se o tipo ou assembly delimitado for compatível com CLS.

  • O membro de um tipo só estará em conformidade com CLS se o tipo for compatível com CLS.

Se um assembly for marcado como compatível com CLS, qualquer tipo exposto publicamente no assembly que não esteja em conformidade com CLS deverá ser marcado com CLSCompliantAttribute o uso de um false argumento. Da mesma forma, se uma classe estiver marcada como compatível com CLS, você deverá marcar individualmente todos os membros que não são compatíveis com CLS. Todos os membros não compatíveis devem fornecer alternativas compatíveis com CLS correspondentes.

Atributos aplicados a assemblies ou módulos devem ocorrer após as cláusulas C# using (Imports em Visual Basic) e antes do código.

Para obter mais informações sobre como usar atributos, consulte Atributos.

Note

O compilador Microsoft Visual Basic atual intencionalmente não gera um aviso de conformidade com CLS, no entanto, uma versão futura do compilador emitirá esse aviso.

Construtores

Nome Description
CLSCompliantAttribute(Boolean)

Inicializa uma instância da CLSCompliantAttribute classe com um valor booliano que indica se o elemento de programa indicado é compatível com CLS.

Propriedades

Nome Description
IsCompliant

Obtém o valor booliano que indica se o elemento de programa indicado é compatível com CLS.
TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para esse Attribute.

(Herdado de Attribute)

Métodos

Nome Description
Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.

(Herdado de Attribute)
GetHashCode()

Devolve o código hash para esta 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 Objectatual.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Implantações explícitas de interface

Nome Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo de um objeto, que podem ser usadas para obter as informações de tipo de uma interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.

(Herdado de Attribute)

Aplica-se a

Confira também