Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StateChangedEventArgs Class

 

Returns data from the StateChanged event.

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

System.Object
  System.EventArgs
    System.Speech.Synthesis.StateChangedEventArgs

public class StateChangedEventArgs : EventArgs

NameDescription
System_CAPS_pubpropertyPreviousState

Gets the state of the SpeechSynthesizer before the StateChanged event.

System_CAPS_pubpropertyState

Gets the state of the SpeechSynthesizer before the StateChanged event.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

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);
    }
  }
}


.NET Framework
Available since 3.0

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

Return to top
Show:
© 2016 Microsoft