Share via

SpeechCommon Client Object

  • Article
  Microsoft Speech Technologies Homepage

The SpeechCommon client object exposes functionality that is used by Basic Speech Controls and by Dialog Speech Controls. This functionality includes the ClientViewState object, which persists client-side variables across postback.

GetViewState Method

Gets a string value from the ClientViewState object.

For more information, see ClientViewState.

string SpeechCommon.GetViewState( string key )

Parameters

  • key
    The name of the variable to restored.

Return value

None.

SetViewState Method

Sets a value in the ClientViewState object.

For more information, see ClientViewState.

function SpeechCommon.SetViewState( string key, string value )

Parameters

  • key
    The name of the variable to saved.
  • value
    The value of the variable to saved.

Return value

None.

Navigates to the specified page.

The current CallInfo object is maintained.

function SpeechCommon.Navigate( string url )

Parameters

  • url
    The URL of the target page.

Return value

None.

needPostback Property

Determines whether RunSpeech will perform a postback when it resumes.

Authors can force a postback by setting the needPostback property in script or code-behind.

Submit Method

Causes a postback to the server.

Client variables are preserved in the ClientViewState object.

On the PocketPC, the Form.submit() method is not guaranteed to preserve client variables through postback. For this reason, authors of speech applications should use SpeechCommon.Submit() rather than Form.submit().

function SpeechCommon.Submit()

Parameters

None.

Return value

None.