CLSCompliantAttribute Class

Article
01/16/2013

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Indicates whether a program element is compliant with the Common Language Specification (CLS). This class cannot be inherited.

Inheritance Hierarchy

System. . :: . .Object
System. . :: . .Attribute
System..::..CLSCompliantAttribute

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
<SerializableAttribute> _
<AttributeUsageAttribute(AttributeTargets.All, Inherited := True, AllowMultiple := False)> _
Public NotInheritable Class CLSCompliantAttribute _
    Inherits Attribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.All, Inherited = true, AllowMultiple = false)]
public sealed class CLSCompliantAttribute : Attribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets::All, Inherited = true, AllowMultiple = false)]
public ref class CLSCompliantAttribute sealed : public Attribute

[<Sealed>]
[<SerializableAttribute>]
[<AttributeUsageAttribute(AttributeTargets.All, Inherited = true, AllowMultiple = false)>]
type CLSCompliantAttribute =  
    class
        inherit Attribute
    end

public final class CLSCompliantAttribute extends Attribute

The CLSCompliantAttribute type exposes the following members.

Constructors

	Name	Description
	CLSCompliantAttribute	Initializes an instance of the CLSCompliantAttribute class with a Boolean value indicating whether the indicated program element is CLS-compliant.

Top

Properties

	Name	Description
	IsCompliant	Gets the Boolean value indicating whether the indicated program element is CLS-compliant.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

You can apply the CLSCompliantAttribute attribute to the following program elements: assembly, module, class, struct, enum, constructor, method, property, field, event, interface, delegate, parameter, and return value. However, the notion of CLS compliance is only meaningful for assemblies, modules, types, and members of types, not parts of a member signature. Consequently, CLSCompliantAttribute is ignored when applied to parameter or return value program elements.

If no CLSCompliantAttribute is applied to a program element, then by default:

The assembly is not CLS-compliant.
The type is CLS-compliant only if its enclosing type or assembly is CLS-compliant.
The member of a type is CLS-compliant only if the type is CLS-compliant.

If an assembly is marked as CLS-compliant, any publicly exposed type in the assembly that is not CLS-compliant must be marked with CLSCompliantAttribute using a false argument. Similarly, if a class is marked as CLS-compliant, you must individually mark all members that are not CLS-compliant. All non-compliant members must provide corresponding CLS-compliant alternatives.

Attributes that are applied to assemblies or modules must occur after the C# using (Imports in Visual Basic) clauses and before the code.

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.

Share via