SrgsToken.Display Property

Definition

Namespace:

System.Speech.Recognition.SrgsGrammar

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

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

public:
 property System::String ^ Display { System::String ^ get(); void set(System::String ^ value); };

public string Display { get; set; }

member this.Display : string with get, set

Public Property Display As String

Property Value

String

A representation of the token as it should be displayed.

Exceptions

ArgumentNullException

An attempt is made to set Display to null.

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