View source for Language - C Sharp Windows Visual Studio

[[Category:Language]]{{NoTitle}}
{|
|style="vertical-align:middle; width: 60%;"|
<font size=6>'''Language - C#'''

'''Windows with Visual Studio'''</font>

Welcome to using Phidgets with C#! By using C#, you will have access to the complete Phidget22 API, including events.

Visual Studio is an IDE provided by Microsoft that can be used to develop code in a wide variety of programming languages, including C#.
|{{TOC limit|2}}
|}

{{Language_-_C_Sharp_Intro|Windows|Visual Studio}}
===Nuget===

The Phidget22.NET library is now available on nuget.org [https://www.nuget.org/packages/Phidget22.NET/ here]. Nuget is the recommended way to install and use the .NET library in Visual Studio. The nuget package bundles the C library on Windows, so there are no other prerequisites that need to be installed. The nuget package adds targets for .NET Core and .NET Standard, so it should be usable from almost any .NET environment which also supports the C library.

==Use Our Examples==
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples, you will need to download and install [https://www.visualstudio.com/ Microsoft Visual Studio].


Now that you have Microsoft Visual Studio installed, select an example that will work with your Phidget:
*{{SampleCode|CSharp|C# Examples}}


Open the example project and start the example by pressing the ''Start'' button:


[[File:Csharp_visualstudio_run.png ‎|link=|center]]


The application will open the Phidget, list basic information about the Phidget, and demonstrate the Phidget's functionality. Here is an example of a Digital Output channel on a RFID Phidget:


[[File:Csharp_visualstudio_rfid.PNG|link=|center]]


{{Edit_the_Examples}}

==Editing the Examples==

The C# examples are what comprise the Windows [[Phidget Control Panel]], so you'll need to modify a few things to adapt them for your own purposes. To begin with, you can remove the following line:
<syntaxhighlight lang='CSharp'>
commandLineData phidgetParameters = open.parseCmdLine(); //get command line parameters
</syntaxhighlight>
Then, you can modify any line that mentions <code>phidgetParameters</code> by setting it to the desired value instead of using PhidgetParameters object.

For instance:
<syntaxhighlight lang='CSharp'>
try
{ //set all the values grabbed from command line.  these values have defaults that are set in ExampleUtils.cs, you can check there to see them.
    digout.Channel = phidgetParameters.Channel; //selects the channel on the device to open
    digout.DeviceSerialNumber = phidgetParameters.SerialNumber; //selects the device or hub to open
    digout.HubPort = phidgetParameters.HubPort; //selects the port on the hub to open
    digout.IsHubPortDevice = phidgetParameters.isHubPortDevice; //is the device a port on a VINT hub?

    if (phidgetParameters.isRemote) //are we trying to open a remote device?
    {
        digout.IsRemote = true;
        Net.EnableServerDiscovery(ServerType.Device); //turn on network scan
        if (phidgetParameters.Password != null && phidgetParameters.ServerName != null)
            Net.SetServerPassword(phidgetParameters.ServerName, phidgetParameters.Password); //set the password if there is one
    }
    else
        digout.IsLocal = true;

    digout.Open(); //open the device specified by the above parameters
}
catch (PhidgetException ex) { errorBox.addMessage("Error opening device: " + ex.Message); }
</syntaxhighlight>

Might become:

<syntaxhighlight lang='CSharp'>
try
{ 
    digout.Channel = 0;
    digout.DeviceSerialNumber = 370097;
    digout.HubPort = 0; 
    digout.IsHubPortDevice = true;
    digout.IsRemote = false;    
    digout.Open();
}
catch (PhidgetException ex) { errorBox.addMessage("Error opening device: " + ex.Message); }
</syntaxhighlight>


You can then manipulate the rest of the code as your application requires. A more in-depth description of programming with Phidgets will be covered in the next section.

==Setting up a New Project==
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget .NET library. To begin:


Create a new project (a Windows Forms Application will be created for this example):

<tabber>
Visual Studio 2017=
[[Image:CSharp_VS2017_New_Project.png|link=|center|700px]]
|-|
Visual Studio 2015=
[[Image:CSharp_VS2015_New_Project.png|link=|center|700px]]
</tabber>


Next, right-click to add a reference to the Phidget .NET library:


[[Image:CSharp_VS2015_Add_Reference.png|link=|center]]


On the following screen, click ''Browse...'' and navigate to the location of Phidget22.NET.dll:
*C:\Program Files\Phidgets\Phidget22\Phidget22.NET.dll


[[Image:CSharp_VS2015_Add_Reference_2.png|link=|center]]


Finally, to include the Phidget .NET library, add the following lines to main window class file:

<syntaxhighlight lang="csharp">
using Phidget22;
using Phidget22.Events;
</syntaxhighlight>

Success! The project now has access to Phidgets.

{{Language Page What's Next}}