VoiceChangeEventArgs Class

.NET Framework (current version)

Returns data from the VoiceChange event.

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

Inheritance Hierarchy

System::Object
System::EventArgs
System.ComponentModel::AsyncCompletedEventArgs
System.Speech.Synthesis::PromptEventArgs
System.Speech.Synthesis::VoiceChangeEventArgs

Syntax

C++

public ref class VoiceChangeEventArgs : PromptEventArgs

Properties

	Name	Description
	Cancelled	Gets a value indicating whether an asynchronous operation has been canceled.(Inherited from AsyncCompletedEventArgs.)
	Error	Gets a value indicating which error occurred during an asynchronous operation.(Inherited from AsyncCompletedEventArgs.)
	Prompt	Gets the prompt associated with the event.(Inherited from PromptEventArgs.)
	UserState	Gets the unique identifier for the asynchronous task.(Inherited from AsyncCompletedEventArgs.)
	Voice	Gets the VoiceInfo object of the new voice.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	RaiseExceptionIfNecessary()	Raises a user-supplied exception if an asynchronous operation failed.(Inherited from AsyncCompletedEventArgs.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

An instance of VoiceChangeEventArgs is created when the SpeechSynthesizer object raises the VoiceChange event. To obtain the identity of the new Voice, access the Voice property in the handler for the event.

You can change the voice in use by the SpeechSynthesizer with any of the PromptBuilder's StartVoice methods or the SpeechSynthesizer's SelectVoice or SelectVoiceByHints methods.

Version Information

.NET Framework
Available since 3.0

Thread Safety

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