XmlDocument.CreateComment-Methode

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

Namespace: System.Xml
Assembly: System.Xml (in system.xml.dll)

Syntax

'Declaration
Public Overridable Function CreateComment ( _
    data As String _
) As XmlComment
'Usage
Dim instance As XmlDocument
Dim data As String
Dim returnValue As XmlComment

returnValue = instance.CreateComment(data)

public virtual XmlComment CreateComment (
    string data
)

public:
virtual XmlComment^ CreateComment (
    String^ data
)

public XmlComment CreateComment (
    String data
)

public function CreateComment (
    data : String
) : XmlComment

Parameter

• data
  Der Inhalt des neuen XmlComment.

Rückgabewert

Der neue XmlComment.

Hinweise

Obwohl diese Methode das neue Objekt im Kontext des Dokuments erstellt, wird es nicht automatisch der Dokumentstruktur hinzugefügt. Rufen Sie eine der Methoden zum Einfügen von Knoten explizit auf, um das neue Objekt hinzuzufügen.

Entsprechend der W3C-Empfehlung Extensible Markup Language (XML) 1.0 (www.w3.org/TR/1998/REC-xml-19980210, nur auf Englisch verfügbar) sind Comment-Knoten nur in Document-, Element- und EntityReference-Knoten zulässig, wenn der EntityReference-Knoten kein untergeordnetes Element eines Attribute-Knotens ist.

Beispiel

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

Option Explicit
Option Strict

Imports System
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 'Main 
End Class 'Sample

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);

  }
}

#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 );
}

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{
    public static void main(String[] args)
    {
        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.get_DocumentElement();
        doc.InsertBefore(newComment, root);

        Console.WriteLine("Display the modified XML...");
        doc.Save(Console.get_Out());
    } //main
} //Sample

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

XmlDocument-Klasse
XmlDocument-Member
System.Xml-Namespace