Partage via


SrgsDocument Constructeurs

Définition

Initialise une nouvelle instance de la classe SrgsDocument.

Surcharges

SrgsDocument()

Initialise une nouvelle instance de la classe SrgsDocument.

SrgsDocument(GrammarBuilder)

Initialise une nouvelle instance de la classe SrgsDocument à partir d'un objet GrammarBuilder.

SrgsDocument(SrgsRule)

Initialise une nouvelle instance de la classe SrgsDocument et spécifie un objet SrgsRule comme règle racine de la grammaire.

SrgsDocument(String)

Initialise une nouvelle instance de la classe SrgsDocument en spécifiant l'emplacement du document XML utilisé pour remplir l'instance de SrgsDocument.

SrgsDocument(XmlReader)

Initialise une nouvelle instance de la classe SrgsDocument d'une instance de XmlReader qui référence un fichier de grammaire au format XML.

Remarques

À l’aide des constructeurs pour la SrgsDocument classe, vous pouvez créer une instance de SrgsDocument à partir d’un GrammarBuilder SrgsRule objet, ou XmlReader , à partir d’une chaîne qui contient le chemin d’accès à une grammaire au format XML, ou vous pouvez lancer une instance vide de SrgsDocument .

SrgsDocument()

Initialise une nouvelle instance de la classe SrgsDocument.

public:
 SrgsDocument();
public SrgsDocument ();
Public Sub New ()

Exemples

L’exemple suivant crée un SrgsDocument objet, puis crée une règle publique nommée winnerRule . Il crée ensuite un SrgsItem qui se compose de la chaîne « un pays qui a gagné la Coupe du monde est : » et ajoute cet élément à la Elements propriété de la règle. L’exemple crée ensuite deux règles supplémentaires ( ruleEurope et ruleSAmerica ), chacune d’entre elles étant un SrgsOneOf objet qui contient trois SrgsItem objets. Après cela, un autre SrgsOneOf objet qui contient SrgsRuleRef des objets faisant référence à et à est créé ruleEurope ruleSAmerica . Le nouvel SrgsOneOf objet est ensuite ajouté à la Elements propriété de winnerRule . Après cela, les trois règles ( winnerRule , ruleEurope et ruleSAmerica ) sont ajoutées à la Rules propriété de SrgsDocument . Enfin, les trois règles sont compilées dans une représentation binaire de la grammaire.

public void WorldSoccerWinners ()  
{  

  // Create an SrgsDocument, create a new rule  
  // and set its scope to public.  
  SrgsDocument document = new SrgsDocument();  
  SrgsRule winnerRule = new SrgsRule("WorldCupWinner");  
  winnerRule.Scope = SrgsRuleScope.Public;  

  // Add the introduction.  
  winnerRule.Elements.Add(new SrgsItem("A nation that has won the World Cup is: "));  

  // Create the rule for the European nations.  
  SrgsOneOf oneOfEurope = new SrgsOneOf(new SrgsItem[] {new SrgsItem("England"),   
    new SrgsItem("France"), new SrgsItem("Germany"), new SrgsItem("Italy")});  
  SrgsRule ruleEurope = (new SrgsRule("EuropeanNations", new SrgsElement[] {oneOfEurope}));  

  // Create the rule for the South American nations.  
  SrgsOneOf oneOfSAmerica = new SrgsOneOf(new SrgsItem[] {new SrgsItem("Argentina"),   
    new SrgsItem("Brazil"), new SrgsItem("Uruguay")});  
  SrgsRule ruleSAmerica = (new SrgsRule("SouthAmericanNations", new SrgsElement[] {oneOfSAmerica}));  

  // Add references to winnerRule for ruleEurope and ruleSAmerica.  
  winnerRule.Elements.Add(new SrgsOneOf(new SrgsItem[] {(new SrgsItem   
    (new SrgsRuleRef(ruleEurope))), new SrgsItem(new SrgsRuleRef(ruleSAmerica))}));  

  // Add all the rules to the document and make winnerRule   
  // the root rule of the document.  
  document.Rules.Add(new SrgsRule[] {winnerRule, ruleEurope, ruleSAmerica});  
  document.Root = winnerRule;  

  String fileName = Path.GetTempFileName();  
  using (FileStream stream = new FileStream(fileName, FileMode.Create))   
  {   

    // Compile the grammar to a binary format.  
    SrgsGrammarCompiler.Compile(document, stream);   
  }  
}  

Remarques

Ce constructeur crée une SrgsDocument instance vide. Pour générer une grammaire dans une SrgsDocument instance vide, ajoutez des instances de classes qui représentent des éléments SRGS, tels que SrgsRule ,, SrgsRuleRef SrgsOneOf et SrgsItem .

S’applique à

SrgsDocument(GrammarBuilder)

Initialise une nouvelle instance de la classe SrgsDocument à partir d'un objet GrammarBuilder.

public:
 SrgsDocument(System::Speech::Recognition::GrammarBuilder ^ builder);
public SrgsDocument (System.Speech.Recognition.GrammarBuilder builder);
new System.Speech.Recognition.SrgsGrammar.SrgsDocument : System.Speech.Recognition.GrammarBuilder -> System.Speech.Recognition.SrgsGrammar.SrgsDocument
Public Sub New (builder As GrammarBuilder)

Paramètres

builder
GrammarBuilder

Objet GrammarBuilder permettant de créer l'instance SrgsDocument.

Exceptions

builder a la valeur null.

Exemples

L’exemple suivant génère une grammaire dans une GrammarBuilder instance à l’aide d' Choices objets. Il crée ensuite un SrgsDocument à partir de l' GrammarBuilder objet.

GrammarBuilder builder = null;  

// Create new Choices objects and add countries/regions, and create GrammarBuilder objects.  
Choices choicesEurope = new Choices(new string[] { "England", "France", "Germany", "Italy" });  
GrammarBuilder europe = new GrammarBuilder(choicesEurope);  

Choices choicesSAmerica = new Choices(new string[] { "Argentina", "Brazil", "Uruguay" });  
GrammarBuilder sAmerica = new GrammarBuilder(choicesSAmerica);  

Choices worldCupWinnerChoices = new Choices(new GrammarBuilder[] {choicesEurope, choicesSAmerica});  

// Create new GrammarBuilder from a Choices object.  
builder = new GrammarBuilder(worldCupWinnerChoices);  

// Create an SrgsDocument object from a GrammarBuilder object.  
SrgsDocument document = new SrgsDocument(builder);  

S’applique à

SrgsDocument(SrgsRule)

Initialise une nouvelle instance de la classe SrgsDocument et spécifie un objet SrgsRule comme règle racine de la grammaire.

public:
 SrgsDocument(System::Speech::Recognition::SrgsGrammar::SrgsRule ^ grammarRootRule);
public SrgsDocument (System.Speech.Recognition.SrgsGrammar.SrgsRule grammarRootRule);
new System.Speech.Recognition.SrgsGrammar.SrgsDocument : System.Speech.Recognition.SrgsGrammar.SrgsRule -> System.Speech.Recognition.SrgsGrammar.SrgsDocument
Public Sub New (grammarRootRule As SrgsRule)

Paramètres

grammarRootRule
SrgsRule

Objet root rule dans l'objet SrgsDocument.

Exceptions

grammarRootRule a la valeur null.

Exemples

L’exemple suivant crée deux règles ( chooseCities et destCities ) pour choisir les villes d’origine et de destination d’un vol. L’exemple initialise l' SrgsDocument instance à l’aide de la chooseCities règle en tant qu’argument. L’exemple écrit le contenu de la collection de règles et le nom de la règle racine dans la console.

// Create a rule that contains a list of destination cities.  
SrgsRule destCities = new SrgsRule("Destination");  
SrgsOneOf toCities = new SrgsOneOf(new string[] { "New York", "Seattle", "Denver" });  
destCities.Add(toCities);  

// Create a list of origin cities and supporting phrases.  
SrgsOneOf fromCities = new SrgsOneOf(new SrgsItem[] {   
  new SrgsItem("Dallas"), new SrgsItem("Miami"), new SrgsItem("Chicago") });  
SrgsItem intro = new SrgsItem("I want to fly from");  
SrgsItem to = new SrgsItem("to");  

// Create the root rule of the grammar, and assemble the components.  
SrgsRule chooseCities = new SrgsRule("Trip");  
chooseCities.Add(intro);  
chooseCities.Add(fromCities);  
chooseCities.Add(to);  
chooseCities.Add(new SrgsRuleRef(destCities));  

// Create the SrgsDocument and specify the root rule to add.  
SrgsDocument bookFlight = new SrgsDocument(chooseCities);  

// Add the rule for the destination cities to the document's rule collection.  
bookFlight.Rules.Add(new SrgsRule[] { destCities });  

// Display the contents of the Rules collection and the name of the root rule.  
foreach (SrgsRule rule in bookFlight.Rules)  
{  
  Console.WriteLine("Rule " + rule.Id + " is in the rules collection");  
}  
Console.WriteLine("Root Rule " + bookFlight.Root.Id);  

// Create a Grammar object and load it to the recognizer.  
Grammar g = new Grammar(bookFlight);  
g.Name = ("City Chooser");  
recognizer.LoadGrammarAsync(g);  

Remarques

Ce constructeur ajoute la règle spécifiée au SrgsRulesCollection de l' SrgsDocument objet et le définit en tant que Root règle de la grammaire.

S’applique à

SrgsDocument(String)

Initialise une nouvelle instance de la classe SrgsDocument en spécifiant l'emplacement du document XML utilisé pour remplir l'instance de SrgsDocument.

public:
 SrgsDocument(System::String ^ path);
public SrgsDocument (string path);
new System.Speech.Recognition.SrgsGrammar.SrgsDocument : string -> System.Speech.Recognition.SrgsGrammar.SrgsDocument
Public Sub New (path As String)

Paramètres

path
String

Emplacement du fichier XML SRGS.

Exceptions

path a la valeur null.

path est une chaîne vide.

Exemples

L’exemple suivant crée un nouveau SrgsDocument à partir du fichier nommé « srgsDocumentFile.xml ».

string srgsDocumentFile = Path.Combine(Path.GetTempPath(), "srgsDocumentFile.xml");  
SrgsDocument document = null;  

if (File.Exists(srgsDocumentFile))  
   document = new SrgsDocument(srgsDocumentFile);  

S’applique à

SrgsDocument(XmlReader)

Initialise une nouvelle instance de la classe SrgsDocument d'une instance de XmlReader qui référence un fichier de grammaire au format XML.

public:
 SrgsDocument(System::Xml::XmlReader ^ srgsGrammar);
public SrgsDocument (System.Xml.XmlReader srgsGrammar);
new System.Speech.Recognition.SrgsGrammar.SrgsDocument : System.Xml.XmlReader -> System.Speech.Recognition.SrgsGrammar.SrgsDocument
Public Sub New (srgsGrammar As XmlReader)

Paramètres

srgsGrammar
XmlReader

Objet XmlReader créé avec l'instance XML SrgsDocument.

Exceptions

srgsGrammar a la valeur null.

Exemples

L’exemple suivant crée une nouvelle instance de SrgsDocument à partir d’une instance de XmlReader qui fait référence au fichier « srgsDocumentFile.xml ».

string srgsDocumentFile = Path.Combine(Path.GetTempPath(), "srgsDocumentFile.xml");  
SrgsDocument document = null;  

if (File.Exists(srgsDocumentFile))  
{  
  XmlReader reader = XmlReader.Create(srgsDocumentFile);  
  document = new SrgsDocument(reader);  
  reader.Close();  
}  

S’applique à