This documentation is archived and is not being maintained.

RecognitionEventArgs Class

Provides information about speech recognition events.

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

public abstract class RecognitionEventArgs : EventArgs

The RecognitionEventArgs type exposes the following members.

Public propertyResultGets the recognition result data associated with the speech recognition event.

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

The Result property obtains the recognition information as a RecognitionResult object. For more information about speech recognition events, see Using Speech Recognition Events.

RecognitionEventArgs is the base for the following classes:

RecognitionEventArgs derives from EventArgs.

The following example attaches a handler for the SpeechHypothesized, SpeechRecognized, and SpeechRecognitionRejected events of the speech recognizer. The event argument types for the three events all derive from RecognitionEventArgs, which is used as the event data parameter in the handler.

// Initialize the speech recognizer.
private void Initialize(SpeechRecognitionEngine recognizer)
  // Attach handlers for the SpeechHypothesized, SpeechRecognitionRejected,
  // and SpeechRecognized events.
  recognizer.SpeechHypothesized +=
    new EventHandler<SpeechHypothesizedEventArgs>(DisplayResult);
  recognizer.SpeechRecognitionRejected +=
    new EventHandler<SpeechRecognitionRejectedEventArgs>(DisplayResult);
  recognizer.SpeechRecognized +=
    new EventHandler<SpeechRecognizedEventArgs>(DisplayResult);

  // Add other initialization code here.

// Handle the SpeechHypothesized, SpeechRecognitionRejected,
// and SpeechRecognized events.
private void DisplayResult(object sender, RecognitionEventArgs e)
  if (e is SpeechHypothesizedEventArgs)
    Console.WriteLine("Speech hypothesized:");
  else if (e is SpeechRecognitionRejectedEventArgs)
    Console.WriteLine("Speech recognition rejected:");
  else if (e is SpeechRecognizedEventArgs)
    Console.WriteLine("Speech recognized:");

  // Add code to handle the event.

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