Skip to main content
Windward

Using NuGet to Install Windward .NET Engine in your Application

Overview  

Windward's .NET Engine is updated for each general release with its current code packaged in the NuGet repository.  This allows you to easily add the Windward .NET Engine to your project without the need to code a build script for the Windward libraries.  We know many of you use NuGet and the request was heard loud and clear.  Follow the instructions below to easily add the Windward .NET Engine to your .NET application and get started generating your reports in no time!

 

To learn more about NuGet a good overview by Scott Hanselman is posted here.

Prerequisites 

In order to take advantage of the NuGet package management tool there are a few things you will need

  • General knowledge of software development.
  • Microsoft Visual Studio
  • A .NET application or .NET Example application from the Windward Engine
  • NuGet (installed by default with most current visions of Microsoft Visual Studio)

Pitfalls

Note:  If you have already installed the AutoTag, Windward .NET Engine or both from the MSI installer on your target computer you must ensure that it is the same version as the current version in the NuGet repository. Differing versions of the .NET Engine installed from both the Windward MSI installers and the NuGet installer will give errors during compilation of your project.

 

A best practice is to first uninstall the AutoTag and/or the Windward .NET Engine from the Windows add/remove programs menu and then use NuGet to install via Visual Studio.

 

After installation you may have similar library names built for different version of .NET added as references to your project. To correct this error simply remove each of the library names that are similar and compile.

List of Similar Libraries

.NET

.NET 3.5 (EOL v15)

   
   
   

Instructions

Step 1: Open Your .NET Application or a Windward Sample .NET Application

  1.  Open your .NET application in Visual Studio.

 

OR

 

  1. Open an example application from the Windward .NET Engine MSI Installation, located in C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\. For this example we will use the .NET Engine Specialized Variable Example application located in C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\.

 

  1. Once Visual Studio is open with the VariableExample application, follow the instructions in Step 2 below.

Step 2: Ensure the NuGet Repository is added to Visual Studio

  1. Open Microsoft Visual Studio and open the Tools menu and from the NuGet Package Manager choose Package Manager Settings.

 

  1. From the Options menu choose Package Sources and ensure the Microsoft and .NET NuGet  default repository is added. If it is not present then click the + icon and use the Name: and Source: settings in the image below.

 

 

Step 3: Use NuGet to get the latest Windward .NET Engine and add it to your application

  1. Open your application project in Visual Studio.  If you do not have a project you can create a new blank project.
  2. From here you have two options, install with the graphical interface or through the console.

Graphical Interface Installation

  1. From the Visual Studio Tools menu and from the NuGet Package Manager choose Manage NuGet Packages for Solution...

  1. In the NuGet window select Browse and enter the search term WindwardEngine (no spaces).
  2. You will see the WindwardEngine package appear. Make sure you select your current project (VariableExample in this case) and then choose Install. Notice that your application references do not yet contain the Windward .NET Engine libraries.

  1. In the Preview window the new Windward .NET Engine library files will be listed during installation. Choose OK to proceed.

  1. After the installation you can view the installed packages by selecting the Install section of the NuGet window and the WindwardEngine package will appear. The console output will show you a detailed list of libraries installed from the package in the Output console. You will also notice under References in the Solution Explorer that the Windward .NET Engine libraries have been automatically added to the open application.

 

  1. If you want to uninstall the WindwardEngine package you can do so by clicking the Uninstall button when the package is selected in the NuGet window.

Console Installation

  1. From the Visual Studio Tools menu and from the NuGet Package Manager choose Package Manager Console.

  1. From the Package Manager Console window you will be presented with a Windows Powershell command prompt, PM>. Enter the command below to install the Windward .NET Engine NuGet packager.

Install-Package WindwardEngine

 

  1. The Windward .NET Engine package will be downloaded, installed and referenced in your current project.  You will now be able to make calls to Windward libraries from your application code. Output showing a successful download using NuGet is listed below.

 

  1. For more details about working with the .NET Engine refer to the article Getting Started with the .NET Engine.

 

Output showing successful download using NuGet

PM> Install-Package WindwardEngine


Attempting to gather dependency information for package 'WindwardEngine.14.0.300' with respect to project 'VariableExample', targeting '.NETFramework,Version=v4.5'
Gathering dependency information took 2.02 sec
Attempting to resolve dependencies for package 'WindwardEngine.14.0.300' with DependencyBehavior 'Lowest'
Resolving dependency information took 0 ms
Resolving actions to install package 'WindwardEngine.14.0.300'
Resolved actions to install package 'WindwardEngine.14.0.300'
Retrieving package 'log4net 2.0.3' from 'nuget.org'.
Retrieving package 'Newtonsoft.Json 6.0.8' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.Core 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.Runtime 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.Charsets 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.Text 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.XML.API 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.Util 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.Media 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.AWT.WinForms 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.SwingAWT 7.2.4630.5' from 'nuget.org'.
Retrieving package 'IKVM.OpenJDK.Security 7.2.4630.5' from 'nuget.org'.
Retrieving package 'WindwardEngine 14.0.300' from 'nuget.org'.
Adding package 'IKVM.OpenJDK.Core.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Core.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Core.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.Core 7.2.4630.5' to VariableExample
Adding package 'IKVM.Runtime.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.Runtime.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.Runtime.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.Runtime 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.Charsets.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Charsets.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Charsets.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.Charsets 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.Text.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Text.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Text.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.Text 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.XML.API.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.XML.API.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.XML.API.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.XML.API 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.Util.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Util.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Util.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.Util 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.Media.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Media.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Media.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.Media 7.2.4630.5' to VariableExample
Adding package 'IKVM.AWT.WinForms.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.AWT.WinForms.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.AWT.WinForms.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.AWT.WinForms 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.SwingAWT.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.SwingAWT.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.SwingAWT.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.SwingAWT 7.2.4630.5' to VariableExample
Adding package 'IKVM.OpenJDK.Security.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Security.7.2.4630.5' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'IKVM.OpenJDK.Security.7.2.4630.5' to 'packages.config'
Successfully installed 'IKVM.OpenJDK.Security 7.2.4630.5' to VariableExample
Adding package 'log4net.2.0.3' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'log4net.2.0.3' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'log4net.2.0.3' to 'packages.config'
Successfully installed 'log4net 2.0.3' to VariableExample
Adding package 'Newtonsoft.Json.6.0.8' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'Newtonsoft.Json.6.0.8' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'Newtonsoft.Json.6.0.8' to 'packages.config'
Executing script file 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages\Newtonsoft.Json.6.0.8\tools\install.ps1'
Successfully installed 'Newtonsoft.Json 6.0.8' to VariableExample
Adding package 'WindwardEngine.14.0.300' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'WindwardEngine.14.0.300' to folder 'C:\Users\USERNAME\Documents\Windward DotNet Engine Samples\CS\Specialized\Variable\packages'
Added package 'WindwardEngine.14.0.300' to 'packages.config'
Successfully installed 'WindwardEngine 14.0.300' to VariableExample
Executing nuget actions took 10.88 sec
Time Elapsed: 00:00:14.0879701

  • Was this article helpful?