Grammar.RuleName Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public string RuleName { get; }

Property Value

Type: System.String

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

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.

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


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.");
  }
}

.NET Framework
Available since 3.0
Return to top
Show: