Export (0) Print
Expand All

CodeAttributeDeclaration Class

Represents an attribute declaration.

System.Object
  System.CodeDom.CodeAttributeDeclaration

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

[SerializableAttribute]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public class CodeAttributeDeclaration

The CodeAttributeDeclaration type exposes the following members.

  NameDescription
Public methodCodeAttributeDeclaration()Initializes a new instance of the CodeAttributeDeclaration class.
Public methodCodeAttributeDeclaration(CodeTypeReference)Initializes a new instance of the CodeAttributeDeclaration class using the specified code type reference.
Public methodCodeAttributeDeclaration(String)Initializes a new instance of the CodeAttributeDeclaration class using the specified name.
Public methodCodeAttributeDeclaration(CodeTypeReference, CodeAttributeArgument[])Initializes a new instance of the CodeAttributeDeclaration class using the specified code type reference and arguments.
Public methodCodeAttributeDeclaration(String, CodeAttributeArgument[])Initializes a new instance of the CodeAttributeDeclaration class using the specified name and arguments.
Top

  NameDescription
Public propertyArgumentsGets the arguments for the attribute.
Public propertyAttributeTypeGets the code type reference for the code attribute declaration.
Public propertyNameGets or sets the name of the attribute being declared.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A CodeAttributeDeclaration can be used to represent an expression that declares an attribute. The attribute name and the arguments for the attribute are stored as properties of the object. A CodeAttributeArgument can be used to represent each argument for the attribute.

The following code example creates a CodeAttributeDeclaration that declares a CLSCompliantAttribute with an argument of false:

using System;
using System.CodeDom;
using System.CodeDom.Compiler;

public class CodeGenExample
{
    static void Main()
    {
        // Declare a new type called Class1.
        CodeTypeDeclaration class1 = new CodeTypeDeclaration("Class1");

        // Declare a new code attribute
        CodeAttributeDeclaration codeAttrDecl = new CodeAttributeDeclaration(
            "System.CLSCompliantAttribute",
            new CodeAttributeArgument(new CodePrimitiveExpression(false)));
        class1.CustomAttributes.Add(codeAttrDecl);

        // Create a C# code provider
        CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp");

        // Generate code and send the output to the console
        provider.GenerateCodeFromType(class1, Console.Out, new CodeGeneratorOptions());
    }
}

// The C# code generator produces the following source code for the preceeding example code: 
// 
// [System.CLSCompliantAttribute(false)] 
// public class Class1 { 
// }

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft