Getting Started with .NET Report Engine

This article gives you the basic information you need to install and test .NET Report Engine.

Requirements#

Windward .NET Engine Versions 16.0 and later

Important

For .NET Engine versions 21.1+ you will need to install the Microsoft Visual C++ Redistributable if you get the following error when trying to output PDF using PDFtron:

System.IO.FileNotFoundException: Could not load file or assembly 'PDFNet.dll' or one of its dependencies.

You can get the installer from here (click here for direct download of x64 version)

Adding NuGet Package to .NET Framework Project#

Follow these steps to add the WindwardEngine NuGet package to your project:

  1. Create a new .NET Framework project in Visual Studio, or open your existing project
  2. Open the Solution Explorer and right click on the solution, then click on "Manage NuGet Packages for Solution"

  1. Then click on browse

]

  1. Then search for "WindwardEngine". Click on WindwardEngine, then check the project checkbox

Important

If you couldnt find the WindwardEngine NuGet package when searching for it in the browse window, make sure you set package source to "nuget.org" like in the picture bellow.

  1. Then click install. You might get a window that says "Preview Changes". Click "OK". The WindwardEngine NuGet project is now added to your solution.

Installing WindwardReports via Zip File#

If you do not want to use NuGet to make use of our reporting engine, we offer the engine, along with all its dependencies as a collection of DLLs in a ZIP file on our website. If you choose to go this route, follow these steps to add the DLLs as references to your .NET Framework project:

  1. Download the ZIP file from the link above and extract it
  2. Create a new .NET Framework project in Visual Studio, or open your existing project
  3. Expand the project in the "Solution Explorer" and right click on "References":

  1. Then click "Browse"

  1. Browse to the extracted ZIP file, then navigate into the "DLLs" directory. Select all the DLLs, and then click "Add":

  1. Click "OK"

You now have all the references you need to make use of our .NET Report Generation Engine.

Adding WindwardReports to your Config File#

To add your license key or any report properties, you need to add a WindwardReports section to your projects .config file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
.
.
.
<WindwardReports>
<add key="license" value="[[LICENSE]]"/>
</WindwardReports>
.
.
.
</configuration>

To learn more about the different properties we provide for report generation, check out this article.

What's Next#

You should checkout the samples we have on out github that makes use of the WindwardEngine NuGet package.