SrgsDocument.Root Property

Gets or sets the root rule of the SrgsDocument class.

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

public SrgsRule Root { get; set; }

Property Value

Type: Microsoft.Speech.Recognition.SrgsGrammar.SrgsRule
Returns the rule that is designated as the root rule of the SrgsDocument.

The SrgsRule object must already be in the document's SrgsRulesCollection before it can be set to the root rule.

You can also set the root rule for an SrgsDocument object by using an SrgsRule object as the argument to the SrgsDocument constructor.

The following example creates a rule named rootRule, and then creates an SrgsDocument object named document. The example then calls the Add method to add the rule to the document. Finally, the example sets the document's Root property to rootRule, thereby making it the root rule.

SrgsRule rootRule = new SrgsRule("WorldCupWinner");
rootRule.Scope = SrgsRuleScope.Public;

SrgsDocument document = new SrgsDocument();

document.Root = rootRule;