XmlWriter.WriteComment(String) XmlWriter.WriteComment(String) XmlWriter.WriteComment(String) XmlWriter.WriteComment(String) Method

Definition

Schreibt beim Überschreiben in einer abgeleiteten Klasse den Kommentar <!--...--> mit dem angegebenen Text.When overridden in a derived class, writes out a comment <!--...--> containing the specified text.

public:
 abstract void WriteComment(System::String ^ text);
public abstract void WriteComment (string text);
abstract member WriteComment : string -> unit
Public MustOverride Sub WriteComment (text As String)

Parameter

text
String String String String

Text, der in den Kommentar eingefügt werden soll.Text to place inside the comment.

Ausnahmen

Der Text ergibt kein wohlgeformtes XML-Dokument.The text would result in a non-well-formed XML document.

Eine XmlWriter-Methode wurde aufgerufen, bevor ein vorheriger asynchroner Vorgang abgeschlossen wurde.An XmlWriter method was called before a previous asynchronous operation finished. In diesem Fall wird InvalidOperationException mit der Meldung „Es wird bereits ein asynchroner Vorgang ausgeführt“ ausgelöst.In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

Beispiele

Im folgenden Beispiel wird eine XML-Datei geschrieben, die ein Buch darstellt.The following example writes an XML file representing a book.

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

}
Option Strict
Option Explicit

Imports System.IO
Imports System.Xml

Public Class Sample
    Private Const filename As String = "sampledata.xml"
    
  Public Shared Sub Main()

     Dim settings As XmlWriterSettings = new XmlWriterSettings()
     settings.Indent = true
     Dim writer As XmlWriter = XmlWriter.Create(filename, settings)
        
     ' Write the Processing Instruction node.
     Dim PItext As String = "type=""text/xsl"" href=""book.xsl"""
     writer.WriteProcessingInstruction("xml-stylesheet", PItext)
        
     'Write the DocumentType node.
     writer.WriteDocType("book", Nothing, Nothing, "<!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()
        
    End Sub 'Main 
End Class 'Sample

Hinweise

Wenn text entweder null <oder ist,schreibtdieseMethodeeinenKommentarohneDateninhalt,z.b.!---->.String.EmptyIf text is either null or String.Empty, this method writes a comment with no data content, for example <!---->.

Wenn text eine ungültige Sequenz von zwei Bindestrichen (XmlTextWriter "-- XmlWriter ") enthält, kann ArgumentException entweder ein-Objekt oder ein Leerzeichen zwischen den Bindestrichen "--" auslösen, sodass der Text ein gültiger XML-XmlWriter Kommentar ist (Objekte, die vom-Objekt erstellt wurden). Create -Methode).If text contains an invalid sequence of two dashes "--" the XmlWriter can either throw an ArgumentException (XmlTextWriter objects) or insert a space between the dashes "- -" so that the text is a valid XML comment (XmlWriter objects created by the Create method).

Die asynchrone Version dieser Methode finden WriteCommentAsyncSie unter.For the asynchronous version of this method, see WriteCommentAsync.

Gilt für: