Display Property

Microsoft Speech Platform SDK 11

previous page next page
Collapse imageExpand ImageCopy imageCopyHover image

Gets or sets the display form of the text to be spoken.

Namespace:  Microsoft.Speech.Recognition.SrgsGrammar
Assembly:  Microsoft.Speech (in Microsoft.Speech.dll)

Syntax

Visual Basic (Declaration)
Public Property Display As String
	Get
	Set
Visual Basic (Usage)
Dim instance As SrgsToken
Dim value As String

value = instance.Display

instance.Display = value
C#
public string Display { get; set; }

Property Value

Type: System..::..String

A representation of the token as it should be displayed.

Exceptions

ExceptionCondition
ArgumentNullException

An attempt is made to set Display to nullNothingnullptrunita null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

An attempt is made to assign an empty string to Display.

Remarks

Although they typically represent the same value, the Display form may be different than the Text form for a word or phrase in a SrgsToken. For example, the display form may be an acronym, such as "USA", while the text that will be spoken, and to which the Pronunciation applies, is "United States of America".

See Also

previous page start next page