How do I develop Silverlight applications that manage markup?

The information in this article applies to:

• VoiceMarkupKit 4

Summary

You can develop Silverlight applications that manage markup using your favorite Silverlight development tools such as Microsoft Visual C# .NET and Microsoft Visual Basic .NET.

More Information

To access the VoiceMarkupKit Silverlight classes within your application, add them to your project References:

To access the VoiceMarkupKit Silverlight classes within your application, add references to the VoiceMarkupKit assemblies in your code:

using System;
...
using Chant.VoiceMarkupKit.Silverlight;
using Chant.Shared.Silverlight;

Imports Chant.VoiceMarkupKit.Silverlight
Imports Chant.Shared.Silverlight
Class MainWindow
...

Out-of-Browser Settings

To run your Silverlight app out-of-browser, set the properties as follows:

1. Within your Silverlight project, select the Silverlight tab under project properties.
2. Select the checkbox: Enable application running out of the browser.
3. Deselect the checkbox: Require elevated trust when running in-browser.
4. Press the Out-of-Browser Settings... button.
5. Select the checkbox: Required elevated trust when running outside the browser.

In-Browser Settings

To run your Silverlight app in-browser, set the properties as follows:

1. Within your Silverlight project, select the Silverlight tab under project properties.
2. Select the checkbox: Require elevated trust when running in-browser.
3. Deselect the checkbox: Enable application running out of the browser.
4. Select the Signing tab under project properties.
5. Select the checkbox: Sign the Xap File.
6. Press one of the three buttons to select a signing certificate:
   1. Select from Store... if you have installed a signing certificate on your system;
   2. Select from File... if you have a signing certificate file your system; or
   3. Create test certificate... if you do not have signing certificate on your system.
7. Press the More Details... button to ensure you have installed Trusted Root and Publisher certificiates:
   1. Press the Install Certificate... button;
   2. Select Automatically ... option if you have Certificate installed in your store or Select Place ... option if you created a temp certificate for testing and press the Browse button;
   3. Select Trusted Root Certification Authorities and press the OK button; and
   4. Press the Next button.
   5. Repeat the process by Pressing the Install Certificate... button;
   6. Select Place ... option and press the Browse button;
   7. Select Trusted Publishers and press the OK button; and
   8. Press the Next button.
8. Run regedit to add a Silverlight registery property AllowElevatedTrustAppsInBrowser with value of 1:
   1. Select the Start menu and enter regedit to launch the Registry Editor;
   2. For Win32 systems, navigate to HKEY_LOCAL_MACHINE\Software\Microsoft\Silverlight\;
   3. For Win64 systems, navigate to HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Silverlight\;
   4. Right click and select New->DWORD (32-bit) Value;
   5. Set the value name to AllowElevatedTrustAppsInBrowser;
   6. Set th value data to 1;
   7. Press the OK button; and
   8. Close the Registry Editor.

Object Instantiation

Declare a global variable for the ChantVM class, instantiate an instance, add the event handler, and set the license and serial properties.

private Chant.VoiceMarkupKit.Silverlight.NChantVM NChantVM1;
public MainPage()
{
    InitializeComponent();
    // Instantiate NChantVM object
    NChantVM1 = new NChantVM(this);
    // Setup event callback handler
    NChantVM1.HasEvent += new Chant.VoiceMarkupKit.Silverlight.NChantVM.HasEventHandler(this.NChantVM1_HasEvent);
    // Set license properties
    NChantVM1.SetStringProperty(ChantStringProperty.CSPLicense, "LicenseRegistrationNumber");
    NChantVM1.SetStringProperty(ChantStringProperty.CSPSerials, "LicenseSerialNumber");
}

Dim WithEvents NChantVM1 As NChantVM

Private Sub UserControl_Loaded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs) Handles MyBase.Loaded
    NChantVM1 = New NChantVM(Me)

    ' Set license properties
    NChantVM1.SetStringProperty(ChantStringProperty.CSPLicense, "LicenseRegistrationNumber")
    NChantVM1.SetStringProperty(ChantStringProperty.CSPSerials, "LicenseSerialNumber")

    ...

End Sub

Event Callbacks

Event callbacks are the mechanism in which the component library sends information back to the application such as there was an error.

private void NChantVM1_HasEvent(object sender, HasEventArgs e)
{
    // Get the number of events
    int numberOfEvents = NChantVM1.GetResourceCount(ChantSpeechResource.CSREvent, 0, 0);
    for (int i = 0; i < numberOfEvents; i++)
    {
        // Get the event from the event queue
        NChantVMEvent nChantVMEvent = NChantVM1.GetChantVMEvent(0);
        switch (nChantVMEvent.ChantCallback)
        {
            case ChantCallback.CCAPIError:
                {
                    ...
                    break;
                }
            default:
                break;
        }
        // Remove the event from the event queue
        NChantVM1.RemoveResource(ChantSpeechResource.CSREvent, 0, 0, "");
    }
}

Private Sub NChantVM1_HasEvent(ByVal sender As System.Object, ByVal e As HasEventArgs) Handles NChantVM1.HasEvent
    Dim I As Integer
    Dim numberOfEvents As Integer
    Dim nChantVMEvent As NChantVMEvent
    ' Get the number of events
    numberOfEvents = NChantVM1.GetResourceCount(ChantSpeechResource.CSREvent, 0, 0)
    For I = 0 To numberOfEvents - 1
        ' Get the event from the event queue
        nChantVMEvent = NChantVM1.GetChantVMEvent(0)
        Select Case nChantVMEvent.ChantCallback
            Case ChantCallback.CCAPIError
                ...
        End Select
        ' Remove the event from the event queue
        NChantVM1.RemoveResource(ChantSpeechResource.CSREvent, 0, 0, "")
    Next
End Sub

Deployment Checklist

When you are ready to deploy your application, you need to ensure you have a valid license, bundle the correct Chant component libraries, and configure your installation properly on the target system. Review the following checklist before deploying your applications:

• You may deploy your Silverlight application to any system with a valid license from the Chant.
• Copy Chant.VoiceMarkupKit.Silverlight.dll and Chant.Shared.Silverlight.dll libraries to the target system or merge them with your application using an obfuscator like .NET Reactor by Eziriz.
• Copy NVoiceMarkupKit.dll to the target system.
• Register NVoiceMarkupKit.dll as a COM library on the target system.

Sample Projects

Silverlight sample projects are installed at the following location: