PromptBuilder.ToXml Method ()


Returns the SSML generated from the PromptBuilder object.

Namespace:   System.Speech.Synthesis
Assembly:  System.Speech (in System.Speech.dll)

public string ToXml()

Return Value

Type: System.String

Returns the SSML generated from the PromptBuilder object as a single line.

The ToXml method makes no attempt to format the returned SSML in any way.

The following example creates a PromptBuilder object, appends text, and then writes the SSML equivalent of the prompt to the console before speaking the contents of the prompt.

using System;
using System.Speech.Synthesis;

namespace SampleSynthesis
  class Program
    static void Main(string[] args)

      // Initialize a new instance of the SpeechSynthesizer.
      using (SpeechSynthesizer synth = new SpeechSynthesizer())

        // Configure the audio output. 

        // Create a PromptBuilder object and add content.
        PromptBuilder style = new PromptBuilder();
        style.AppendText("Your order for");
        style.StartStyle(new PromptStyle(PromptRate.Slow));
        style.AppendText("one kitchen sink and one faucet");
        style.AppendText("has been confirmed.");

        // Write the contents of the PromptBuilder object to the console as
        // an SSML-compatible XML file.
        string myXml = style.ToXml();
        Console.WriteLine("This is the SSML equivalent of the PromptBuilder: \n\n" + myXml);

        // Speak the contents of the SSML prompt.

      Console.WriteLine("Press any key to exit...");

.NET Framework
Available since 3.0
Return to top