CodeAttributeArgument Class


Represents an argument used in a metadata attribute declaration.

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


public class CodeAttributeArgument


Initializes a new instance of the CodeAttributeArgument class.


Initializes a new instance of the CodeAttributeArgument class using the specified value.

System_CAPS_pubmethodCodeAttributeArgument(String, CodeExpression)

Initializes a new instance of the CodeAttributeArgument class using the specified name and value.


Gets or sets the name of the attribute.


Gets or sets the value for the attribute argument.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

CodeAttributeArgument can be used to represent either the value for a single argument of an attribute constructor, or a value with which to initialize a property of the attribute.

The Value property indicates the value of the argument. The Name property, when used, indicates the name of a property of the attribute to which to assign the value.

Attribute declarations are frequently initialized with a number of arguments that are passed into the constructor of the attribute at run time. To provide arguments to the constructor for an attribute, add a CodeAttributeArgument for each argument to the Arguments collection of a CodeAttributeDeclaration. Only the Value property of each CodeAttributeArgument needs to be initialized. The order of arguments within the collection must correspond to the order of arguments in the method signature of the constructor for the attribute.

You can also set properties of the attribute that are not available through the constructor by providing a CodeAttributeArgument that indicates the name of the property to set, along with the value to set.

The following code creates a class, and adds code attributes to declare that the class is serializable and obsolete.

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");

        // Use attributes to mark the class as serializable and obsolete.
        CodeAttributeDeclaration codeAttrDecl =
            new CodeAttributeDeclaration("System.Serializable");

        CodeAttributeArgument codeAttr =
            new CodeAttributeArgument( new CodePrimitiveExpression("This class is obsolete."));
        codeAttrDecl = new CodeAttributeDeclaration("System.Obsolete", codeAttr);

        // 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.Serializable()]
// [System.Obsolete("This class is obsolete.")]
// public class Class1 {
// }

.NET Framework
Available since 1.1

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

Return to top