XmlDocument.CreateComment(String) Methode

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlDocument.cs

Erstellt einen XmlComment, der die angegebenen Daten enthält.

public:
 virtual System::Xml::XmlComment ^ CreateComment(System::String ^ data);

public virtual System.Xml.XmlComment CreateComment (string? data);

abstract member CreateComment : string -> System.Xml.XmlComment
override this.CreateComment : string -> System.Xml.XmlComment

Public Overridable Function CreateComment (data As String) As XmlComment

Parameter

data

String

Der Inhalt des neuen XmlComment.

Gibt zurück

XmlComment

Die neue XmlComment.

Beispiele

Im folgenden Beispiel wird ein Kommentar erstellt und einem XML-Dokument hinzugefügt.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlDocument^ doc = gcnew XmlDocument;
   doc->LoadXml( "<book genre='novel' ISBN='1-861001-57-5'><title>Pride And Prejudice</title></book>" );
   
   //Create a comment.
   XmlComment^ newComment;
   newComment = doc->CreateComment( "Sample XML document" );
   
   //Add the new node to the document.
   XmlElement^ root = doc->DocumentElement;
   doc->InsertBefore( newComment, root );
   Console::WriteLine( "Display the modified XML..." );
   doc->Save( Console::Out );
}

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

public class Sample
{
  public static void Main()
  {
    XmlDocument doc = new XmlDocument();
    doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" +
                "<title>Pride And Prejudice</title>" +
                "</book>");

    //Create a comment.
    XmlComment newComment;
    newComment = doc.CreateComment("Sample XML document");

    //Add the new node to the document.
    XmlElement root = doc.DocumentElement;
    doc.InsertBefore(newComment, root);

    Console.WriteLine("Display the modified XML...");
    doc.Save(Console.Out);
  }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml

Public Class Sample
    
    Public Shared Sub Main()
        Dim doc As New XmlDocument()
        doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" & _
                    "<title>Pride And Prejudice</title>"  & _
                    "</book>")
        
        'Create a comment.
        Dim newComment As XmlComment
        newComment = doc.CreateComment("Sample XML document")
        
        'Add the new node to the document.
        Dim root As XmlElement = doc.DocumentElement
        doc.InsertBefore(newComment, root)
        
        Console.WriteLine("Display the modified XML...")
        doc.Save(Console.Out)
    End Sub
End Class

Hinweise

Obwohl diese Methode das neue Objekt im Kontext des Dokuments erstellt, fügt sie das neue Objekt nicht automatisch der Dokumentstruktur hinzu. Um das neue Objekt hinzuzufügen, müssen Sie explizit eine der Knoteneinfügemethoden aufrufen.

Gemäß der W3C Extensible Markup Language (XML) 1.0-Empfehlung sind Kommentarknoten nur innerhalb der Document-, Element- und EntityReference-Knoten zulässig, wenn der EntityReference-Knoten kein untergeordnetes Element eines Attributknotens ist.