This topic has not yet been rated - Rate this topic

CodeConstructor Class

Represents a declaration for an instance constructor of a type.

System.Object
  System.CodeDom.CodeObject
    System.CodeDom.CodeTypeMember
      System.CodeDom.CodeMemberMethod
        System.CodeDom.CodeConstructor

Namespace:  System.CodeDom
Assembly:  System (in System.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public class CodeConstructor : CodeMemberMethod

The CodeConstructor type exposes the following members.

  Name Description
Public method CodeConstructor Initializes a new instance of the CodeConstructor class.
Top
  Name Description
Public property Attributes Gets or sets the attributes of the member. (Inherited from CodeTypeMember.)
Public property BaseConstructorArgs Gets the collection of base constructor arguments.
Public property ChainedConstructorArgs Gets the collection of chained constructor arguments.
Public property Comments Gets the collection of comments for the type member. (Inherited from CodeTypeMember.)
Public property CustomAttributes Gets or sets the custom attributes of the member. (Inherited from CodeTypeMember.)
Public property EndDirectives Gets the end directives for the member. (Inherited from CodeTypeMember.)
Public property ImplementationTypes Gets the data types of the interfaces implemented by this method, unless it is a private method implementation, which is indicated by the PrivateImplementationType property. (Inherited from CodeMemberMethod.)
Public property LinePragma Gets or sets the line on which the type member statement occurs. (Inherited from CodeTypeMember.)
Public property Name Gets or sets the name of the member. (Inherited from CodeTypeMember.)
Public property Parameters Gets the parameter declarations for the method. (Inherited from CodeMemberMethod.)
Public property PrivateImplementationType Gets or sets the data type of the interface this method, if private, implements a method of, if any. (Inherited from CodeMemberMethod.)
Public property ReturnType Gets or sets the data type of the return value of the method. (Inherited from CodeMemberMethod.)
Public property ReturnTypeCustomAttributes Gets the custom attributes of the return type of the method. (Inherited from CodeMemberMethod.)
Public property StartDirectives Gets the start directives for the member. (Inherited from CodeTypeMember.)
Public property Statements Gets the statements within the method. (Inherited from CodeMemberMethod.)
Public property TypeParameters Gets the type parameters for the current generic method. (Inherited from CodeMemberMethod.)
Public property UserData Gets the user-definable data for the current object. (Inherited from CodeObject.)
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event PopulateImplementationTypes An event that will be raised the first time the ImplementationTypes collection is accessed. (Inherited from CodeMemberMethod.)
Public event PopulateParameters An event that will be raised the first time the Parameters collection is accessed. (Inherited from CodeMemberMethod.)
Public event PopulateStatements An event that will be raised the first time the Statements collection is accessed. (Inherited from CodeMemberMethod.)
Top

CodeConstructor can be used to represent a declaration of an instance constructor for a type. Use CodeTypeConstructor to declare a static constructor for a type.

If the constructor calls a base class constructor, set the constructor arguments for the base class constructor in the BaseConstructorArgs property. If the constructor overloads another constuctor for the type, set the constructor arguments to pass to the overloaded type constructor in the ChainedConstructorArgs property.

This example demonstrates using a CodeConstructor to declare several types of constructors.


            // This example declares two types, one of which inherits from another,
            // and creates a set of different styles of constructors using CodeConstructor.

            // Creates a new CodeCompileUnit to contain the program graph.
            CodeCompileUnit CompileUnit = new CodeCompileUnit();
            // Declares a new namespace object and names it.
            CodeNamespace Samples = new CodeNamespace("Samples");
            // Adds the namespace object to the compile unit.
            CompileUnit.Namespaces.Add( Samples );
            // Adds a new namespace import for the System namespace.
            Samples.Imports.Add( new CodeNamespaceImport("System") );            

            // Declares a new type and names it.
            CodeTypeDeclaration BaseType = new CodeTypeDeclaration("BaseType");                                                
            // Adds the new type to the namespace object's type collection.
            Samples.Types.Add(BaseType);

            // Declares a default constructor that takes no arguments.
            CodeConstructor defaultConstructor = new CodeConstructor();
            defaultConstructor.Attributes = MemberAttributes.Public;
            // Adds the constructor to the Members collection of the BaseType.
            BaseType.Members.Add(defaultConstructor);

            // Declares a constructor that takes a string argument.
            CodeConstructor stringConstructor = new CodeConstructor();
            stringConstructor.Attributes = MemberAttributes.Public;
            // Declares a parameter of type string named "TestStringParameter".
            stringConstructor.Parameters.Add( new CodeParameterDeclarationExpression("System.String", "TestStringParameter") );
            // Adds the constructor to the Members collection of the BaseType.
            BaseType.Members.Add(stringConstructor);

            // Declares a type that derives from BaseType and names it.
            CodeTypeDeclaration DerivedType = new CodeTypeDeclaration("DerivedType");
            // The DerivedType class inherits from the BaseType class.
            DerivedType.BaseTypes.Add( new CodeTypeReference("BaseType") );
            // Adds the new type to the namespace object's type collection.
            Samples.Types.Add(DerivedType);        

            // Declare a constructor that takes a string argument and calls the base class constructor with it.
            CodeConstructor baseStringConstructor = new CodeConstructor();
            baseStringConstructor.Attributes = MemberAttributes.Public;
            // Declares a parameter of type string named "TestStringParameter".    
            baseStringConstructor.Parameters.Add( new CodeParameterDeclarationExpression("System.String", "TestStringParameter") );
            // Calls a base class constructor with the TestStringParameter parameter.
            baseStringConstructor.BaseConstructorArgs.Add( new CodeVariableReferenceExpression("TestStringParameter") );
            // Adds the constructor to the Members collection of the DerivedType.
            DerivedType.Members.Add(baseStringConstructor);

            // Declares a constructor overload that calls another constructor for the type with a predefined argument.
            CodeConstructor overloadConstructor = new CodeConstructor();
            overloadConstructor.Attributes = MemberAttributes.Public;
            // Sets the argument to pass to a base constructor method.
            overloadConstructor.ChainedConstructorArgs.Add( new CodePrimitiveExpression("Test") );
            // Adds the constructor to the Members collection of the DerivedType.
            DerivedType.Members.Add(overloadConstructor);        

            // Declares a constructor overload that calls the default constructor for the type.
            CodeConstructor overloadConstructor2 = new CodeConstructor();
            overloadConstructor2.Attributes = MemberAttributes.Public;
            overloadConstructor2.Parameters.Add( new CodeParameterDeclarationExpression("System.Int32", "TestIntParameter") );
            // Sets the argument to pass to a base constructor method.
            overloadConstructor2.ChainedConstructorArgs.Add( new CodeSnippetExpression("") );
            // Adds the constructor to the Members collection of the DerivedType.
            DerivedType.Members.Add(overloadConstructor2);            

            // A C# code generator produces the following source code for the preceeding example code:

            // public class BaseType {
            //     
            //     public BaseType() {
            //     }
            //        
            //     public BaseType(string TestStringParameter) {
            //     }
            // }
            //    
            // public class DerivedType : BaseType {
            //        
            //     public DerivedType(string TestStringParameter) : 
            //             base(TestStringParameter) {
            //     }
            //        
            //     public DerivedType() : 
            //             this("Test") {
            //     }
            //
            //     public DerivedType(int TestIntParameter) : 
            //                this() {
            //     }
            // }



.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ