StateChangedEventArgs Class

Definition

Namespace:

System.Speech.Synthesis

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Source:

SynthesizerStateChangedEventArgs.cs

Returns data from the StateChanged event.

public ref class StateChangedEventArgs : EventArgs

public class StateChangedEventArgs : EventArgs

type StateChangedEventArgs = class
    inherit EventArgs

Public Class StateChangedEventArgs
Inherits EventArgs

Inheritance

Object

EventArgs

StateChangedEventArgs

Examples

The following example demonstrates the information that is available about the StateChanged event.

using System;  
using System.Speech.Synthesis;  

namespace SampleSynthesis  
{  
  class Program  
  {  

    static void Main(string[] args)  
    {  

      // Initialize a new instance of the SpeechSynthesizer.  
      using (SpeechSynthesizer synth = new SpeechSynthesizer())  
      {  

        // Configure the audio output.   
        synth.SetOutputToDefaultAudioDevice();  

        // Subscribe to StateChanged event.  
        synth.StateChanged += new EventHandler<StateChangedEventArgs>(synth_StateChanged);  

        // Subscribe to the SpeakProgress event.  
        synth.SpeakProgress += new EventHandler<SpeakProgressEventArgs>(synth_SpeakProgress);  

        // Speak the prompt.  
        synth.Speak("What is your favorite color?");  

        // Pause the SpeechSynthesizer object.  
        synth.Pause();  

        // Resume the SpeechSynthesizer object.  
        synth.Resume();  
      }  

      Console.WriteLine("\nPress any key to exit...");  
      Console.ReadKey();  
    }  

    // Write the state of the SpeechSynthesizer to the console.  
    static void synth_StateChanged(object sender, StateChangedEventArgs e)  
    {  
      Console.WriteLine("State: {0}    Previous State: {1}\n", e.State, e.PreviousState);  
    }  

    // Write the speak progress of the SpeechSynthesizer to the console.  
    static void synth_SpeakProgress(object sender, SpeakProgressEventArgs e)  
    {  
      Console.WriteLine(e.Text);  
    }  
  }  
}  

Remarks

An instance of StateChangedEventArgs is created when the SpeechSynthesizer object raises the StateChanged event. To obtain the values for the new and the previous SynthesizerState, access the State and PreviousState properties in the handler for the event.

Properties

PreviousState	Gets the state of the SpeechSynthesizer before the StateChanged event.
State	Gets the state of the SpeechSynthesizer before the StateChanged event.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (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)
ToString()	Returns a string that represents the current object. (Inherited from Object)