SrgsDocument Class

 

Defines a design-time object that is used to build strongly-typed runtime grammars that conform to the Speech Recognition Grammar Specification (SRGS) Version 1.0.

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

System.Object
  System.Speech.Recognition.SrgsGrammar.SrgsDocument

[SerializableAttribute]
public class SrgsDocument

NameDescription
System_CAPS_pubmethodSrgsDocument()

Initializes a new instance of the SrgsDocument class.

System_CAPS_pubmethodSrgsDocument(GrammarBuilder)

Initializes a new instance of the SrgsDocument class from a GrammarBuilder object.

System_CAPS_pubmethodSrgsDocument(SrgsRule)

Initializes a new instance of the SrgsDocument class and specifies an SrgsRule object to be the root rule of the grammar.

System_CAPS_pubmethodSrgsDocument(String)

Initializes a new instance of the SrgsDocument class specifying the location of the XML document that is used to fill in the SrgsDocument instance.

System_CAPS_pubmethodSrgsDocument(XmlReader)

Initializes a new instance of the SrgsDocument class from an instance of XmlReader that references an XML-format grammar file.

NameDescription
System_CAPS_pubpropertyAssemblyReferences

Gets the assembly reference information for the SrgsDocument instance.

System_CAPS_pubpropertyCodeBehind

Gets the code-behind information for the SrgsDocument instance.

System_CAPS_pubpropertyCulture

Gets or sets the culture information for the SrgsDocument instance.

System_CAPS_pubpropertyDebug

Gets or sets whether line numbers should be added to inline scripts.

System_CAPS_pubpropertyImportNamespaces

Gets the related namespaces for the current SrgsDocument instance.

System_CAPS_pubpropertyLanguage

Gets or sets the programming language used for inline code in the SrgsDocument class.

System_CAPS_pubpropertyMode

Gets or sets the mode for the SrgsDocument class.

System_CAPS_pubpropertyNamespace

Gets or sets the namespace of the SrgsDocument class.

System_CAPS_pubpropertyPhoneticAlphabet

Gets or sets the phonetic alphabet of the SrgsDocument class.

System_CAPS_pubpropertyRoot

Gets or sets the root rule of the SrgsDocument class.

System_CAPS_pubpropertyRules

Gets the collection of rules that are currently defined for the SrgsDocument class.

System_CAPS_pubpropertyScript

Gets or sets the .NET scripting language for the SrgsDocument class.

System_CAPS_pubpropertyXmlBase

Gets or sets the base URI of the SrgsDocument class.

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

System_CAPS_pubmethodWriteSrgs(XmlWriter)

Writes the contents of the SrgsDocument object to an XML-format grammar file that conforms to the Speech Recognition Grammar Specification (SRGS) Version 1.0.

You can you construct an empty SrgsDocument instance and build a grammar by adding instances of classes that represent SRGS elements, such as SrgsRule, SrgsOneOf,SrgsItem, SrgsRuleRef, SrgsSemanticInterpretationTag, and SrgsToken. You can also construct an SrgsDocument instance from an existing SRGS-compliant XML grammar file, from an instance of SrgsRule, or from an instance of GrammarBuilder.

After the SrgsDocument object is created, it can be loaded into a Grammar object or compiled by SrgsGrammarCompiler, enabling it to be read by a Grammar object.

See Create Grammars Using SrgsGrammar in the System Speech Programming Guide for .NET Framework 4.0 for more information and examples.

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