Grammar.RuleName Property

Definition

Namespace:

System.Speech.Recognition

Assembly:

System.Speech.dll

Package:

System.Speech v10.0.0-preview.1.25080.5

Source:

Grammar.cs

Gets the name of the root rule or entry point of a Grammar object.

C#

public string RuleName { get; }

Property Value

String

The RuleName property returns the identifier for the root rule of the referenced speech recognition grammar. The default is null.

Examples

The following example writes information about a Grammar object to the console.

C#

private static void DumpGrammarStatus(Grammar item)
{
  Console.WriteLine("Grammar name is {0}:", item.Name);
  Console.WriteLine("  The Grammar {0} loaded.",
    item.Loaded ? "is" : "is not");
  Console.WriteLine("  The Grammar {0} enabled.",
    item.Enabled ? "is" : "is not");
  if (item.RuleName != null)
  {
    Console.WriteLine("  The root rule is {0}.", item.RuleName);
  }
  else
  {
    Console.WriteLine("  The Grammar does not specify a root rule.");
  }
}

Remarks

To construct a Grammar object and set the name for its root rule, use one of the Grammar constructors that takes the ruleName parameter.

If the root rule of a Grammar has no name, the property returns null.

The root rules of Grammar instances constructed from GrammarBuilder objects typically have no name, so RuleName returns null.

Applies to

See also

• Grammar(Stream)
• SpeechRecognizer
• SpeechRecognitionEngine