This documentation is archived and is not being maintained.

EmulateRecognizeCompletedEventArgs Class

Provides data for the EmulateRecognizeCompleted event of the SpeechRecognizer and SpeechRecognitionEngine classes.


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

public class EmulateRecognizeCompletedEventArgs : AsyncCompletedEventArgs

The EmulateRecognizeCompletedEventArgs type exposes the following members.

Public propertyCancelledGets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs.)
Public propertyErrorGets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs.)
Public propertyResultGets the results of emulated recognition.
Public propertyUserStateGets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs.)

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.)
Protected methodRaiseExceptionIfNecessaryRaises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

An instance of EmulateRecognizeCompletedEventArgs is created when the SpeechRecognitionEngine object raises the EmulateRecognizeCompleted event. To obtain information about the result of recognition, access the Result property in the handler for the event.

Emulation is the process by which text, instead of audio, is the input to a speech recognition engine. To bypass the audio inputs for a SpeechRecognitionEngine object during emulation, use the SetInputToNull() method.

If the speech recognition engine encounters an exception during the recognition operation, the Error property is set to the exception and the Result property is set to null.

EmulateRecognizeCompletedEventArgs derives from AsyncCompletedEventArgs.

The following example adds an event handler for the EmulateRecognizeCompleted event to a SpeechRecognitionEngine. The handler gets the recognized text from the Result property.

private SpeechRecognitionEngine sre;

// Initialize the speech recognition engine. 
private void Initialize()
  sre = new SpeechRecognitionEngine();

  // Add a handler for the EmulateRecognizeCompleted event.
  sre.EmulateRecognizeCompleted += new EventHandler<EmulateRecognizeCompletedEventArgs>(sre_EmulateRecognizeCompleted);

  // Add other initialization code here.

// Handle the EmulateRecognizeCompleted event. 
void sre_EmulateRecognizeCompleted(object sender, EmulateRecognizeCompletedEventArgs e)
  if (e.Result == null) return;

  string phrase = e.Result.Text;

  // Add event handler code here.

.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.