Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

After reading this document you will know how-to download, install and use the CodeSmith Generator SDK in your applications. This document will also demonstrate the most common uses of the CodeSmith Generator API:

...

Download

After logging into your account, visit the following downloads section to download the latest version of CodeSmith Generator.

...

  • Embed the license file into your application as an embedded resource in the assembly that calls the CodeSmith.Engine.
  • Place the license file into the same directory as your application.
  • Specify a license key via the Generator:License environment variable or in code via the CodeSmithLicense.SetLicenseKey(key) method. We only recommend this for build/web servers as this will overwrite any locally defined licenses.

Creating a new project

In order to use the CodeSmith Generator SDK you will need to create a new .Net 4.0 6.2 or newer project. In the example below, we will be creating a new console application.

...

Next, you are required to reference the following assemblies:

  • CodeSmith.ActiproSoftware.Text.Wpf.dll
  • CodeSmith.Core.dll
  • CodeSmith.Engine.dll

 

Info
These assemblies will be located in the CodeSmith Generator's Program Files folder if you installed CodeSmith Generator.

...

NuGet packages:


In the example below we will also need to reference the following assemblies:

...

NuGet packages:

Writing the Code

Now it's time to dive in and write some generation code!  We will add the following code to our console application: 

...

The above code will compile and run but requires the Stored Procedures template that can be found in the APISample project that was mentioned above. If you have any SDK API questions feel free to contact support.

...