Microsoft Visual Studio Wizard for EntireX .NET Wrapper

The Visual Studio Wizard for .NET Wrapper is a plug-in for Microsoft Visual Studio, which makes the functionality of the EntireX .NET Wrapper available to Microsoft Visual Studio.

This document covers the following topics:

Supported versions of Microsoft Visual Studio and other prerequisites for EntireX components are described centrally. See Windows Prerequisites.


Installing the Plug-in

The EntireX .NET Wrapper Wizard Plug-in for Visual Studio .NET is part of the EntireX installation. After you have installed EntireX, you can find the installer under etc in your EntireX installation path. To install EntireX .NET Wrapper Plug-in, start NetVSAddIn103.msi and follow the instructions.

Note:
We recommend you close all other Microsoft applications before installing the plug-in.

Caution:
The installation path must include the bin directory (e.g. C:\SoftwareAG\EntireX\bin) of the corresponding EntireX installation, otherwise the plug-in will not work properly!

Using the Plug-in

Once the wizard has been installed, start Microsoft Visual Studio. Under New Project > Installed > Templates > Visual C#, you will find a new template called EntireX .NET Wrapper Application.

Select this template to start the .NET Wrapper Wizard.

graphics/dnw06.png

First enter the name of a Software AG IDL file in the opening window. You can select whatever you want to generate client or server code. The project name will be set to IDLNameClient or IDLNameServer automatically. You can enter the name of the path of the .NET Wrapper Runtime DLL if it is not located in the default path.

graphics/dnw08.png

On the page Broker/Service you can change the default settings for Broker and Service.

graphics/dnw09.png

On the parameters page you can select the options Sanitize and char/string support.

For more information on Broker/Service and parameters, see the EntireX .NET Wrapper documentation.

When all data has been entered, click the button Finish. A new Visual Studio .NET solution will be generated which includes a project with the name IDLNameClient or IDLNameServer. This project contains the Software AG IDL file, the generated .cs file C# file) and references to the System.dll and the EntireX.NetWrapper.Runtime.dll.

The project will generate a class library (DLL), which can be used in any other .NET project C# or VB.NET). For this purpose an additional App.config file is generated which can be used in a project where an .exe file is generated. The App.config file contains information about Broker, Services etc.

Caution:
Any changes to the Software AG IDL file will trigger the EntireX AddIn after saving. The .cs file will be re-generated and all specifications you made during the implementation will be lost.

Uninstalling the Plug-in

You can uninstall the EntireX .NET Wrapper Wizard Plug-in for Visual Studio by using the Windows Control Panel > Add or Remove Programs. Select Software AG EntireX .NET Wrapper Wizard and choose Remove.

The EntireX .NET Wrapper Wizard Plug-in for Visual Studio will be removed from your computer.

Note:
The plug-in must be uninstalled before you uninstall EntireX, otherwise the uninstall of EntireX will fail.