This topic has not yet been rated - Rate this topic

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.

  Name Description
Public method SrgsDocument() Initializes a new instance of the SrgsDocument class.
Public method SrgsDocument(GrammarBuilder) Initializes a new instance of the SrgsDocument class from a GrammarBuilder object.
Public method SrgsDocument(SrgsRule) Initializes a new instance of the SrgsDocument class and specifies an SrgsRule object to be the root rule of the grammar.
Public method SrgsDocument(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 method SrgsDocument(XmlReader) Initializes a new instance of the SrgsDocument class from an instance of XmlReader that references an XML-format grammar file.
Top
  Name Description
Public property AssemblyReferences Gets the assembly reference information for the SrgsDocument instance.
Public property CodeBehind Gets the code-behind information for the SrgsDocument instance.
Public property Culture Gets or sets the culture information for the SrgsDocument instance.
Public property Debug Gets or sets whether line numbers should be added to inline scripts.
Public property ImportNamespaces Gets the related namespaces for the current SrgsDocument instance.
Public property Language Gets or sets the programming language used for inline code in the SrgsDocument class.
Public property Mode Gets or sets the mode for the SrgsDocument class.
Public property Namespace Gets or sets the namespace of the SrgsDocument class.
Public property PhoneticAlphabet Gets or sets the phonetic alphabet of the SrgsDocument class.
Public property Root Gets or sets the root rule of the SrgsDocument class.
Public property Rules Gets the collection of rules that are currently defined for the SrgsDocument class.
Public property Script Gets or sets the .NET scripting language for the SrgsDocument class.
Public property XmlBase Gets or sets the base URI of the SrgsDocument class.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method WriteSrgs 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.
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, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ