Export (0) Print
Expand All

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.

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

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

[SerializableAttribute]
public class SrgsDocument

The SrgsDocument type exposes the following members.

  NameDescription
Public methodSrgsDocument()Initializes a new instance of the SrgsDocument class.
Public methodSrgsDocument(GrammarBuilder)Initializes a new instance of the SrgsDocument class from a GrammarBuilder object.
Public methodSrgsDocument(SrgsRule)Initializes a new instance of the SrgsDocument class and specifies an SrgsRule object to be the root rule of the grammar.
Public methodSrgsDocument(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.
Public methodSrgsDocument(XmlReader)Initializes a new instance of the SrgsDocument class from an instance of XmlReader that references an XML-format grammar file.
Top

  NameDescription
Public propertyAssemblyReferencesGets the assembly reference information for the SrgsDocument instance.
Public propertyCodeBehindGets the code-behind information for the SrgsDocument instance.
Public propertyCultureGets or sets the culture information for the SrgsDocument instance.
Public propertyDebugGets or sets whether line numbers should be added to inline scripts.
Public propertyImportNamespacesGets the related namespaces for the current SrgsDocument instance.
Public propertyLanguageGets or sets the programming language used for inline code in the SrgsDocument class.
Public propertyModeGets or sets the mode for the SrgsDocument class.
Public propertyNamespaceGets or sets the namespace of the SrgsDocument class.
Public propertyPhoneticAlphabetGets or sets the phonetic alphabet of the SrgsDocument class.
Public propertyRootGets or sets the root rule of the SrgsDocument class.
Public propertyRulesGets the collection of rules that are currently defined for the SrgsDocument class.
Public propertyScriptGets or sets the .NET scripting language for the SrgsDocument class.
Public propertyXmlBaseGets or sets the base URI of the SrgsDocument class.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteSrgsWrites the contents of the SrgsDocument object to an XML-format grammar file that conforms to the Speech Recognition Grammar Specification (SRGS) Version 1.0.
Top

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

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft