This documentation is archived and is not being maintained.

Prompt Class

Represents information about what can be rendered, either text or an audio file, by the SpeechSynthesizer.

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

public class Prompt

The Prompt type exposes the following members.

Public methodPrompt(PromptBuilder)Creates a new instance of the Prompt class from a PromptBuilder object.
Public methodPrompt(String)Creates a new instance of the Prompt class and specifies the text to be spoken.
Public methodPrompt(String, SynthesisTextFormat)Creates a new instance of the Prompt class and specifies the text to be spoken and whether its format is plain text or markup language.

Public propertyIsCompletedGets whether the Prompt has finished playing.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

A Prompt object can contain plain text, text formatted with markup language, or audio files.

An empty Prompt object is created with each new instance of PromptBuilder. The PromptBuilder class provides methods for adding content, including text, SSML markup, bookmarks, and prerecorded audio files (such as .wav files), to the empty Prompt object that it contains. Typically, applications will use PromptBuilder, rather than a Prompt object, to create prompts and populate them with content.

To generate speech from the contents of a Prompt object, use the Speak(Prompt) method.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.