XmlWriter.WriteComment(String) Yöntem

Tanım

Ad Alanı:

System.Xml

Bütünleştirilmiş Kod:

System.Xml.ReaderWriter.dll

Bütünleştirilmiş Kod:

System.Xml.dll

Bütünleştirilmiş Kod:

netstandard.dll

Türetilmiş bir sınıfta geçersiz kılındığında, belirtilen metni içeren bir açıklama <!--...--> yazar.

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)

Parametreler

text

String

Açıklamanın içine yerleştirecek metin.

Özel durumlar

ArgumentException

Metin iyi biçimlendirilmemiş bir XML belgesine neden olur.

InvalidOperationException

Önceki XmlWriter bir zaman uyumsuz işlem tamamlanmadan önce bir yöntem çağrıldı. Bu durumda, InvalidOperationException "Zaman uyumsuz bir işlem zaten devam ediyor" iletisiyle oluşturulur.

Örnekler

Aşağıdaki örnek, bir kitabı temsil eden bir XML dosyası yazar.

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

Açıklamalar

veya String.Emptyise text null, bu yöntem veri içeriği olmayan bir açıklama yazar, örneğin<!---->.

text geçersiz bir "--" XmlWriter tire dizisi içeriyorsa, metin geçerli bir ArgumentException XML açıklamasıXmlWriter (yöntem tarafından Create oluşturulan nesneler) olacak şekilde bir (XmlTextWriter nesneler) oluşturabilir veya "- -" tirelerinin arasına bir boşluk ekleyebilir.

Bu yöntemin zaman uyumsuz sürümü için bkz WriteCommentAsync. .