Enabled Property

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Gets or sets whether a voice can be used to generate speech.

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

Syntax

Visual Basic (Declaration)
Public Property Enabled As Boolean
	Get
	Set
Visual Basic (Usage)
Dim instance As InstalledVoice
Dim value As Boolean

value = instance.Enabled

instance.Enabled = value
C#
public bool Enabled { get; set; }

Property Value

Type: System..::..Boolean

Returns a bool that represents the enabled state of the voice.

Remarks

The value of the Enabled property is true by default. When an application calls GetInstalledVoices()()()(), the method verifies that each of the voices it finds in the registry meets certain minimum criteria. For any voice that fails verification, GetInstalledVoices()()()() sets its Enabled property to false. An application cannot select a voice whose Enabled property is false. Typically, applications will not set a voice's Enabled property.

See Also