System.CodeDom 9.0.0

About

Provides functionality for dynamically generating and compiling source code using the Code Document Object Model (CodeDOM).

It allows developers to represent code in a language-agnostic format and then generate code in multiple languages, such as C# and VB.NET. The primary use cases include creating dynamic code generation tools, runtime code generation, and facilitating code analysis or transformation.

For a new modern development consider using the .NET Compiler Platform SDK, in particular Roslyn source generators.

Key Features

  • Write code using a common object model that can be translated into multiple programming languages.
  • Generate and compile code at runtime based on the CodeDOM.

How to Use

Generating and compiling C# code:

using System.CodeDom;
using System.CodeDom.Compiler;
using Microsoft.CSharp;

// Create a new CodeCompileUnit to hold the code
var compileUnit = new CodeCompileUnit();

// Create a namespace
var codeNamespace = new CodeNamespace("MyNamespace");
compileUnit.Namespaces.Add(codeNamespace);

// Create a class
var classDeclaration = new CodeTypeDeclaration("MyClass")
{
    IsClass = true
};
codeNamespace.Types.Add(classDeclaration);

// Add a simple method to the class
var method = new CodeMemberMethod
{
    Name = "HelloWorld",
    ReturnType = new CodeTypeReference(typeof(void)),
};
classDeclaration.Members.Add(method);

var methodInvocation = new CodeMethodInvokeExpression(new CodeTypeReferenceExpression("Console"),
                                                      "WriteLine",
                                                      new CodePrimitiveExpression("Hello, World!"));
method.Statements.Add(methodInvocation);

// Generate C# code from the CodeDOM structure
CodeDomProvider provider = new CSharpCodeProvider();

using (var writer = new StringWriter())
{
    var codeGenereationOptions = new CodeGeneratorOptions()
    {
        BlankLinesBetweenMembers = false,
        IndentString = "  ",
    };

    provider.GenerateCodeFromCompileUnit(compileUnit, writer, codeGenereationOptions);
    Console.WriteLine(writer.GetStringBuilder().ToString());
}

This example generates:

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

namespace MyNamespace {

  public class MyClass {
    private void HelloWorld() {
      Console.WriteLine("Hello, World!");
    }
  }
}

Main Types

The main types provided by this library are:

  • System.CodeDom.CodeObject
  • System.CodeDom.CodeCompileUnit
  • System.CodeDom.CodeNamespace
  • System.CodeDom.CodeTypeDeclaration
  • System.CodeDom.CodeMemberMethod
  • System.CodeDom.CodeTypeReference
  • System.CodeDom.CodeMethodInvokeExpression
  • System.CodeDom.CodeTypeReferenceExpression
  • System.CodeDom.CodePrimitiveExpression
  • System.CodeDom.Compiler.CodeDomProvider
  • System.CodeDom.Compiler.CodeGeneratorOptions
  • Microsoft.CSharp.CSharpCodeProvider
  • Microsoft.VisualBasic.VBCodeProvider

Additional Documentation

Feedback & Contributing

System.CodeDom is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Showing the top 20 packages that depend on System.CodeDom.

Packages Downloads
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET as well as .NET Standard.
77
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET as well as .NET Standard.
87
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET as well as .NET Standard.
90
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET Core as well as .NET Standard.
78
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET Core as well as .NET Standard. 8f968b9e79c5721d78cc88e46fe57457fe9d490d When using NuGet 3.x this package requires at least version 3.4.
78
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET Core as well as .NET Standard. When using NuGet 3.x this package requires at least version 3.4.
81
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET Core as well as .NET Standard. When using NuGet 3.x this package requires at least version 3.4.
83
Microsoft.Windows.Compatibility
This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET Core as well as .NET Standard. When using NuGet 3.x this package requires at least version 3.4.
89
Mono.TextTemplating
Open source implementation of the T4 templating engine This package allows embedding the T4 engine in an application. * To install as a dotnet global or local tool, use `dotnet-t4` instead. * To install in a project as a `DotNetCliToolReference`, use `dotnet-t4-project-tool` instead.
1,362
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery
76
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery
86
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery
88
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery
92
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery
96
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery 10dc31ea70c14a33f371cea5a757a3d95b218acf When using NuGet 3.x this package requires at least version 3.4.
102
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery 30ab651fcb4354552bd4891619a0bdd81e0ebdbf When using NuGet 3.x this package requires at least version 3.4.
98
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery When using NuGet 3.x this package requires at least version 3.4.
93
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery When using NuGet 3.x this package requires at least version 3.4.
97
System.Management
Provides access to a rich set of management information and management events about the system, devices, and applications instrumented to the Windows Management Instrumentation (WMI) infrastructure. Commonly Used Types: System.Management.ManagementClass System.Management.ManagementObject System.Management.SelectQuery When using NuGet 3.x this package requires at least version 3.4.
113

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

  • No dependencies.

.NET 8.0

  • No dependencies.

.NET 9.0

  • No dependencies.

.NET Standard 2.0

  • No dependencies.

Version Downloads Last updated
9.0.0 5 11/14/2024
9.0.0-rc.2.24473.5 7 10/15/2024
9.0.0-rc.1.24431.7 5 09/16/2024
9.0.0-preview.7.24405.7 8 08/14/2024
9.0.0-preview.6.24327.7 9 07/10/2024
9.0.0-preview.5.24306.7 8 06/17/2024
9.0.0-preview.4.24266.19 10 05/21/2024
9.0.0-preview.3.24172.9 11 04/30/2024
9.0.0-preview.2.24128.5 7 04/30/2024
9.0.0-preview.1.24080.9 9 02/25/2024
8.0.0 12 11/16/2023
8.0.0-rc.2.23479.6 14 10/13/2023
8.0.0-rc.1.23419.4 13 09/17/2023
8.0.0-preview.7.23375.6 28 08/13/2023
8.0.0-preview.6.23329.7 17 07/12/2023
8.0.0-preview.5.23280.8 45 06/26/2023
8.0.0-preview.4.23259.5 22 06/12/2023
8.0.0-preview.3.23174.8 28 05/28/2023
8.0.0-preview.2.23128.3 19 04/07/2023
8.0.0-preview.1.23110.8 18 04/07/2023
7.0.0 83 12/21/2022
7.0.0-rc.2.22472.3 51 10/31/2022
7.0.0-rc.1.22426.10 58 09/22/2022
7.0.0-preview.7.22375.6 65 08/20/2022
7.0.0-preview.6.22324.4 82 09/23/2022
7.0.0-preview.5.22301.12 77 09/22/2022
7.0.0-preview.4.22229.4 39 09/25/2022
7.0.0-preview.3.22175.4 19 10/31/2022
7.0.0-preview.2.22152.2 38 07/28/2022
7.0.0-preview.1.22076.8 43 09/22/2022
6.0.2-mauipre.1.22102.15 31 09/25/2022
6.0.2-mauipre.1.22054.8 29 08/11/2022
6.0.0 44 09/03/2022
6.0.0-rc.2.21480.5 94 10/31/2022
6.0.0-rc.1.21451.13 36 09/23/2022
6.0.0-preview.7.21377.19 37 09/21/2022
6.0.0-preview.6.21352.12 49 09/24/2022
6.0.0-preview.5.21301.5 43 09/22/2022
6.0.0-preview.4.21253.7 25 09/22/2022
6.0.0-preview.3.21201.4 89 09/22/2022
6.0.0-preview.2.21154.6 75 09/24/2022
6.0.0-preview.1.21102.12 41 09/26/2022
5.0.0 28 09/11/2022
5.0.0-rc.2.20475.5 40 09/21/2022
5.0.0-rc.1.20451.14 32 09/21/2022
5.0.0-preview.8.20407.11 48 09/21/2022
5.0.0-preview.7.20364.11 82 09/22/2022
5.0.0-preview.6.20305.6 90 09/14/2022
5.0.0-preview.5.20278.1 102 09/23/2022
5.0.0-preview.4.20251.6 13 09/24/2022
5.0.0-preview.3.20214.6 51 10/31/2022
5.0.0-preview.2.20160.6 44 09/23/2022
5.0.0-preview.1.20120.5 43 09/21/2022
4.7.0 43 06/27/2022
4.7.0-preview3.19551.4 96 09/21/2022
4.7.0-preview2.19523.17 55 09/23/2022
4.7.0-preview1.19504.10 91 09/21/2022
4.6.0 82 08/13/2022
4.6.0-rc1.19456.4 50 09/24/2022
4.6.0-preview9.19421.4 80 09/23/2022
4.6.0-preview9.19416.11 32 09/26/2022
4.6.0-preview8.19405.3 34 09/23/2022
4.6.0-preview7.19362.9 80 10/31/2022
4.6.0-preview6.19303.8 23 09/24/2022
4.6.0-preview6.19264.9 37 09/22/2022
4.6.0-preview5.19224.8 82 09/24/2022
4.6.0-preview4.19212.13 35 09/21/2022
4.6.0-preview3.19128.7 72 09/22/2022
4.6.0-preview.19073.11 29 09/23/2022
4.6.0-preview.18571.3 78 09/23/2022
4.5.0 97 09/03/2022
4.5.0-rc1 75 09/07/2022
4.5.0-preview2-26406-04 34 09/22/2022
4.5.0-preview1-26216-02 87 09/21/2022
4.5.0-preview1-25914-04 36 09/25/2022
4.4.0 1,344 09/10/2022
4.4.0-preview2-25405-01 26 09/22/2022
4.4.0-preview1-25305-02 21 09/22/2022