XmlDocument.CreateComment(String) Metodo

Definizione

Spazio dei nomi:

System.Xml

Assembly:

System.Xml.dll

Crea un oggetto XmlComment contenente i dati specificati.

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

Parametri

data

String

Contenuto del nuovo XmlCommentoggetto .

Valori restituiti

XmlComment

XmlCommentNuovo oggetto .

Esempio

Nell'esempio seguente viene creato un commento e viene aggiunto a un documento XML.

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

Commenti

Anche se questo metodo crea il nuovo oggetto nel contesto del documento, non aggiunge automaticamente il nuovo oggetto all'albero del documento. Per aggiungere il nuovo oggetto, è necessario chiamare in modo esplicito uno dei metodi di inserimento del nodo.

In base alla raccomandazione W3C Extensible Markup Language (XML) 1.0, i nodi commento sono consentiti solo all'interno dei nodi Document, Element e EntityReference, quando il nodo EntityReference non è figlio di un nodo Attribute.