SrgsDocument Class

.NET Framework (current version)

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)

Inheritance Hierarchy

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

Syntax

C++

[SerializableAttribute]
public ref class SrgsDocument

Constructors

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

Properties

	Name	Description
	AssemblyReferences	Gets the assembly reference information for the SrgsDocument instance.
	CodeBehind	Gets the code-behind information for the SrgsDocument instance.
	Culture	Gets or sets the culture information for the SrgsDocument instance.
	Debug	Gets or sets whether line numbers should be added to inline scripts.
	ImportNamespaces	Gets the related namespaces for the current SrgsDocument instance.
	Language	Gets or sets the programming language used for inline code in the SrgsDocument class.
	Mode	Gets or sets the mode for the SrgsDocument class.
	Namespace	Gets or sets the namespace of the SrgsDocument class.
	PhoneticAlphabet	Gets or sets the phonetic alphabet of the SrgsDocument class.
	Root	Gets or sets the root rule of the SrgsDocument class.
	Rules	Gets the collection of rules that are currently defined for the SrgsDocument class.
	Script	Gets or sets the .NET scripting language for the SrgsDocument class.
	XmlBase	Gets or sets the base URI of the SrgsDocument class.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	WriteSrgs(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.

Version Information

.NET Framework
Available since 3.0

Thread Safety

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