PromptBuilder.AppendTextWithHint Method

Definition

Namespace:

System.Speech.Synthesis

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Appends text to the PromptBuilder object and specifies the content type of the text.

Overloads

AppendTextWithHint(String, String)	Appends text to the PromptBuilder object and a String that specifies the content type of the text.
AppendTextWithHint(String, SayAs)	Appends text to the PromptBuilder object and specifies the content type using a member of the SayAs enumeration.

AppendTextWithHint(String, String)

Appends text to the PromptBuilder object and a String that specifies the content type of the text.

public:
 void AppendTextWithHint(System::String ^ textToSpeak, System::String ^ sayAs);

public void AppendTextWithHint (string textToSpeak, string sayAs);

member this.AppendTextWithHint : string * string -> unit

Public Sub AppendTextWithHint (textToSpeak As String, sayAs As String)

Parameters

textToSpeak

String

A string containing the text to be spoken.

sayAs

String

The content type of the text.

Remarks

You can use this method to specify a content type that is not included in the SayAs enumeration. However, the TTS engine must support the parameter that you specify.

AppendTextWithHint(String, SayAs)

Appends text to the PromptBuilder object and specifies the content type using a member of the SayAs enumeration.

public:
 void AppendTextWithHint(System::String ^ textToSpeak, System::Speech::Synthesis::SayAs sayAs);

public void AppendTextWithHint (string textToSpeak, System.Speech.Synthesis.SayAs sayAs);

member this.AppendTextWithHint : string * System.Speech.Synthesis.SayAs -> unit

Public Sub AppendTextWithHint (textToSpeak As String, sayAs As SayAs)

Parameters

textToSpeak

String

A string containing the text to be spoken.

sayAs

SayAs

The content type of the text.

Examples

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.   
        synth.SetOutputToDefaultAudioDevice();  

        // Create a PromptBuilder object and define the data types for some of the added strings.  
        PromptBuilder sayAs = new PromptBuilder();  
        sayAs.AppendText("Your");  
        sayAs.AppendTextWithHint("1st", SayAs.NumberOrdinal);  
        sayAs.AppendText("request was for");  
        sayAs.AppendTextWithHint("1", SayAs.NumberCardinal);  
        sayAs.AppendText("room, on");  
        sayAs.AppendTextWithHint("10/19/2012,", SayAs.MonthDayYear);  
        sayAs.AppendText("with early arrival at");  
        sayAs.AppendTextWithHint("12:35pm", SayAs.Time12);  

        // Speak the contents of the SSML prompt.  
        synth.Speak(sayAs);  
      }  

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

Remarks

The content type specified by sayAs can provide guidance to the speech synthesis engine about how to pronounce the contents of textToSpeak.