XmlWriter.WriteComment(String) Méthode

Définition

Espace de noms:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

En cas de substitution dans une classe dérivée, écrit un commentaire <!--...--> contenant le texte spécifié.

C#

public abstract void WriteComment (string text);

C#

public abstract void WriteComment (string? text);

Paramètres

text

String

Texte à placer dans le commentaire.

Exceptions

ArgumentException

Le texte est à l'origine d'un document XML incorrect.

InvalidOperationException

Une méthode XmlWriter a été appelée avant la fin d’une opération asynchrone précédente. Dans ce cas, l’exception InvalidOperationException est levée avec le message « Une opération asynchrone est déjà en cours ».

Exemples

L’exemple suivant écrit un fichier XML représentant un livre.

C#

using System;
using System.IO;
using System.Xml;

public class Sample {

  private const string filename = "sampledata.xml";

  public static void Main() {

     XmlWriterSettings settings = new XmlWriterSettings();
     settings.Indent = true;
     XmlWriter writer = XmlWriter.Create(filename, settings);

     // Write the Processing Instruction node.
     String PItext="type=\"text/xsl\" href=\"book.xsl\"";
     writer.WriteProcessingInstruction("xml-stylesheet", PItext);

     // Write the DocumentType node.
     writer.WriteDocType("book", null , null, "<!ENTITY h \"hardcover\">");

     // Write a Comment node.
     writer.WriteComment("sample XML");

     // Write the root element.
     writer.WriteStartElement("book");

     // Write the genre attribute.
     writer.WriteAttributeString("genre", "novel");

     // Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014");

     // Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale");

     // Write the style element.
     writer.WriteStartElement("style");
     writer.WriteEntityRef("h");
     writer.WriteEndElement();

     // Write the price.
     writer.WriteElementString("price", "19.95");

     // Write CDATA.
     writer.WriteCData("Prices 15% off!!");

     // Write the close tag for the root element.
     writer.WriteEndElement();

     writer.WriteEndDocument();

     // Write the XML to file and close the writer.
     writer.Flush();
     writer.Close();
  }
}

Remarques

S’il null text s’agit de l’un ou l’autre, String.Emptycette méthode écrit un commentaire sans contenu de données, par exemple<!---->.

S’il text contient une séquence non valide de deux tirets « -- », il XmlWriter peut lever un ArgumentException (XmlTextWriter objets) ou insérer un espace entre les tirets « - » afin que le texte soit un commentaire XML valide (XmlWriter objets créés par la Create méthode).

Pour obtenir la version asynchrone de cette méthode, consultez WriteCommentAsync.

S’applique à