PromptBuilder.AppendTextWithAlias(String, String) Method

Definition

Namespace:

System.Speech.Synthesis

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0

Source:

PromptBuilder.cs

Appends text to the PromptBuilder object and specifies the alias text to be spoken in place of the appended text.

public:
 void AppendTextWithAlias(System::String ^ textToSpeak, System::String ^ substitute);

public void AppendTextWithAlias (string textToSpeak, string substitute);

member this.AppendTextWithAlias : string * string -> unit

Public Sub AppendTextWithAlias (textToSpeak As String, substitute As String)

Parameters

textToSpeak

String

A string containing the text representation.

substitute

String

A string containing the text to be spoken.

Examples

The following example appends a text string ("Speech Synthesis Markup Language") and its alias ("SSML") to a PromptBuilder object. The synthesizer will pronounce "S S M L".

PromptBuilder alias = new PromptBuilder();  
alias.AppendTextWithAlias("Speech Synthesis Markup Language","SSML");   

Remarks

This allows a document to contain both a spoken and a written form for a prompt. For example, the written form could be an acronym, such as SAPI, and the spoken form could be the expanded text for the acronym, in this case Speech Application Programming Interface.