XmlDocument.CreateComment(String) Methode

Definitie

Naamruimte:

System.Xml

Assembly's:

netstandard.dll, System.Xml.ReaderWriter.dll

Bron:

XmlDocument.cs

Hiermee maakt u een XmlComment met de opgegeven gegevens.

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

Parameters

data

String

De inhoud van de nieuwe XmlComment.

Retouren

XmlComment

Het nieuwe XmlComment.

Voorbeelden

In het volgende voorbeeld wordt een opmerking gemaakt en toegevoegd aan een XML-document.

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

Opmerkingen

Hoewel met deze methode het nieuwe object wordt gemaakt in de context van het document, wordt het nieuwe object niet automatisch toegevoegd aan de documentstructuur. Als u het nieuwe object wilt toevoegen, moet u expliciet een van de methoden voor het invoegen van knooppunten aanroepen.

Volgens de aanbeveling W3C Extensible Markup Language (XML) 1.0 zijn opmerkingenknooppunten alleen toegestaan binnen document-, element- en EntityReference-knooppunten wanneer het knooppunt EntityReference geen onderliggend element van een kenmerkknooppunt is.