GuruxFile component

This guide shows you how to use Gurux file component (GXFile) in the Visual Studio .NET environment using the C# language. Source code is available at sourceforge.net

Adding GXFile component to the project

Start Visual Studio .NET
Open the project where you want to add the GXFile component, or create a new one
Open Toolbox

Note:

implement it manually

Under Gurux tab, select the component, and drag and drop it on the form
Allow the use of any version of the media component:
- Select the component.
- In Solution Explorer view, in the References folder, select Gurux.GuruxFile.
- In Properties view, set Specific Version to False.

Using components with .NET

You can either drag the component to the form, or create it dynamically.

Creating component dynamically

To create component in runtime, select Add Reference in the Project menu. The dialog shows available components, select the one(s) to use (in this case Gurux file component). Click OK to finish. The following example shows how to create a GXFile component.

using GruxFileLib;
//Create new component
GXFile GXFile1 = new GXFileClass();

Setting Media Properties

You can either select appropriate settings in the Properties dialog or edit the settings programmatically.

  //Set file path to watch.
  GXFile1.FilePath = ("C:\\temp\\");
  GXFile1.Filter = "*.txt";
  GXFile1.RemoveAfterRead = True;
  GXFile1.Open();

Sending and receiving packets

All data is sent asynchronously. Response is received as a Received event message.

Receiving event messages

To receive event sent by the GXFile component, select the component by right-clicking it on the form and select Properties. Create handlers for OnError and OnReceived methods.

To create a handler, select an event and enter name for the handler. In the following example, received data is converted to string and stored.

  private void GXFile1_OnReceived(object sender, object Data, string SenderInfo)
  {
    //Update data to the edit box.
    if (GXFile1.Encoding == Gurux.File.Encoding.String)
    {
      ReceivedText.Text += Data.ToString();
    }
    else
    {
      ReceivedText.Text = ReceivedText.Text + BitConverter.ToString((byte[]) Data);
    }
    //Update Sender Information to the edit box.
    SenderText.Text = SenderInfo;
  }

  private void GXFile1_OnError(object sender, string ErrorInfo)
  {
    MessageBox.Show(sender.ToString());
  }

Error Handling

It's very important to consider error handling when sending and receiving data. The connection can drop down, or something else unexpected may happen. If something unwanted happens, Gurux file component returns error. The following example shows how to handle errors in .NET.

try
{
  GXFile1.Write("c:\\temp\\test.txt", "Hello world!");
}
catch(Exception ex)
{
  MessageBox.Show(ex.ToString());
}

Using the components from development environment

Using from .NET | Using from Visual Basic | Using from C++