XmlWriter.WriteComment(String) Methode

Definitie

Naamruimte:
System.Xml
Assembly's:
System.Xml.dll, System.Xml.ReaderWriter.dll
Assembly's:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Bron:
XmlWriter.cs
Bron:
XmlWriter.cs
Bron:
XmlWriter.cs
Bron:
XmlWriter.cs
Bron:
XmlWriter.cs

Wanneer deze wordt overschreven in een afgeleide klasse, schrijft u een opmerking <--...--> met de opgegeven tekst.

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

Parameters

text
String

Tekst die in de opmerking moet worden geplaatst.

Uitzonderingen

ArgumentException

De tekst zou resulteren in een niet-goed opgemaakt XML-document.

InvalidOperationException

Er XmlWriter is een methode aangeroepen voordat een vorige asynchrone bewerking is voltooid. In dit geval InvalidOperationException wordt het bericht 'Er wordt al een asynchrone bewerking uitgevoerd'.

Voorbeelden

In het volgende voorbeeld wordt een XML-bestand geschreven dat een boek vertegenwoordigt.

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
End Class

Opmerkingen

Als text dat het geval null is of String.Empty, schrijft deze methode een opmerking zonder gegevensinhoud, bijvoorbeeld <---->.

Als text er een ongeldige reeks van twee streepjes (--) bevat, kan er XmlWriter een ArgumentException (objecten) wordenXmlTextWriter gegenereerd of een spatie tussen de streepjes '- -' worden ingevoegd, zodat de tekst een geldige XML-opmerking is (XmlWriter objecten die door de Create methode zijn gemaakt).

Zie voor de asynchrone versie van deze methode WriteCommentAsync.

Van toepassing op