Set Up Your Development Environment

In this procedure, you will learn how to set up your development environment to develop Microsoft .NET and Silverlight clients.

Before You Begin

This procedure is part of Checklist: Build Microsoft .NET and Silverlight Clients Using Kaazing WebSocket Gateway:

  1. Set Up Your Development Environment
  2. Interact with Kaazing WebSocket Gateway Using the WebSocket API
  3. Interact with Kaazing WebSocket Gateway Using the EventSource API
  4. Interact with Kaazing WebSocket Gateway Using the ByteSocket API
  5. Configure Automatic Connection
  6. Secure Your Microsoft .NET and Silverlight Client
  7. Display Logs for .NET and Silverlight Clients
  8. Troubleshoot Your Microsoft .NET and Silverlight Clients

Note: Learn about supported browsers, operating systems, and platform versions in the Release Notes.

To Set Up Your Development Environment

To develop applications for Silverlight or the .NET Framework, you must install the a .NET Integrated Development Environment (IDE) such as Visual Studio or the free Visual Studio Express.

Note: You can develop Silverlight and .NET Framework applications in any of the .NET programming languages. Microsoft Visual C# is used in this how-to.

Silverlight Environment Setup

In addition to the Visual Studio IDE, Silverlight application development also requires:

  • A .NET Integrated Development Environment (IDE) such as Visual Studio or the free Visual Web Developer Express
  • Microsoft Silverlight 4 SDK
  • The Silverlight 4 browser plugin

To use the Kaazing client libraries for .NET and Silverlight, you must add a reference to the libraries located in the .DLL file Kaazing.Gateway.dll to your Silverlight project. You can find this .DLL file in the directory GATEWAY_HOME/lib/client/dotnet.

Note: You can develop Silverlight 4 applications in any of the .NET programming languages. Microsoft Visual C# is used in this how-to.

Silverlight applications primarily consist of Extensible Application Markup Language (XAML) files and their corresponding code-behind classes .XAML.CS (in C#). The .XAML files typically contain the User Interface (UI) elements and the .XAML.CS files contain the page's code-behind classes.

A typical Silverlight application is deployed as a compressed .XAP file. Adding the reference to the .DLL file in your Silverlight application packages the .DLL file in your finished application. To deploy your Silverlight application .XAP file, you can host it on Kaazing WebSocket Gateway. For example, you can place it in the web directory GATEWAY_HOME/web/base.

For more information on the Kaazing client libraries for .NET and Silverlight, see the .NET and Silverlight Client API documentation.

.NET Framework Environment Setup

In addition to the Visual Studio IDE, .NET Framework application development also requires:

  • A .NET Integrated Development Environment (IDE), such as Visual Studio or the free Visual Web Developer Express
  • Microsoft .NET Framework 4 with Microsoft .NET Framework 4 Patch KB2468871 (download the patch from http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=3556). This is required for building or running .NET clients using the Kaazing WebSocket Gateway .NET Client Library.

To use the Kaazing client libraries for .NET and Silverlight, you must add a reference to the Kaazing libraries located in the .DLL file Kaazing.Gateway.dll to your Silverlight project. This file is in the directory GATEWAY_HOME/lib/client/dotnet/Release. Additional .DLLs may be required to program with other protocols.

Applications based on the .NET Framework can use standard .NET Forms Controls or Windows Presentation Foundation (WPF). Note that there are slight differences in APIs for Controls, Threading and Dispatching behavior. The steps in this document illustrate event dispatching for WPF applications. WPF Applications, like Silverlight applications, consist of Extensible Application Markup Language (XAML) files and their corresponding code-behind classes .XAML.CS (in C#).

.NET Framework applications are typically deployed as an executable .EXE file. This executable references the.DLL file and can be deployed in the same directory alongside the executable, or registered through an installation process.

API Documentation

For more information on the Kaazing client libraries for .NET and Silverlight, see the .NET and Silverlight Client API documentation. Alternatively, to access the Kaazing client libraries for .NET and Silverlight API documentation in Visual Studio (after you have added a reference to the client libraries to your .NET or Silverlight project), select Object Browser from the View menu and choose Kaazing.HTML5.

Next Step

Interact with Kaazing WebSocket Gateway Using the WebSocket API

See Also

.NET and Silverlight Client API

TOP