XmlDocument.CreateComment(String) Methode

Definition

Namespace:
System.Xml
Assemblys:
System.Xml.dll, System.Xml.XmlDocument.dll
Assemblys:
netstandard.dll, System.Xml.ReaderWriter.dll
Assembly:
System.Xml.XmlDocument.dll
Assembly:
System.Xml.ReaderWriter.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Quelle:
XmlDocument.cs
Quelle:
XmlDocument.cs
Quelle:
XmlDocument.cs
Quelle:
XmlDocument.cs
Quelle:
XmlDocument.cs

Erstellt eine XmlComment mit den angegebenen Daten enthaltende Daten.

public:
 virtual System::Xml::XmlComment ^ CreateComment(System::String ^ data);
public virtual System.Xml.XmlComment CreateComment(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;
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, wird das neue Objekt nicht automatisch der Dokumentstruktur hinzugefügt. Um das neue Objekt hinzuzufügen, müssen Sie explizit eine der Methoden zum Einfügen von Knoten aufrufen.

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

Gilt für: