XmlWriter.WriteComment(String) Metodo

Definizione

Spazio dei nomi:

System.Xml

Assembly:

netstandard.dll, System.Xml.ReaderWriter.dll

Origine:

XmlWriter.cs

Quando sottoposto a override in una classe derivata, scrive un commento <!--...--> che contiene il testo specificato.

C#

public abstract void WriteComment(string? text);

Parametri

text

String

Testo da inserire nel commento.

Eccezioni

ArgumentException

Il testo genera un documento XML di formato non corretto.

InvalidOperationException

È stato chiamato un metodo della classe XmlWriter prima del completamento di un'operazione asincrona precedente. In questo caso, viene generata l'eccezione InvalidOperationException con il messaggio "È già in corso un'operazione asincrona".

Esempio

Nell'esempio seguente viene scritto un file XML che rappresenta un libro.

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();
  }
}

Commenti

Se text è null o String.Empty, questo metodo scrive un commento senza contenuto di dati, ad esempio <!---->.

Se text contiene una sequenza non valida di due trattini "--" XmlWriter può generare un ArgumentException oggetto (XmlTextWriter oggetti) o inserire uno spazio tra i trattini "- -" in modo che il testo sia un commento XML valido (XmlWriter oggetti creati dal Create metodo ).

Per la versione asincrona di questo metodo, vedere WriteCommentAsync.

Si applica a