XmlDocument.CreateComment Method

Creates an XmlComment containing the specified data.

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

public virtual XmlComment CreateComment(
	string data
)

Parameters

data
Type: System.String

The content of the new XmlComment.

Return Value

Type: System.Xml.XmlComment
The new XmlComment.

Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. To add the new object, you must explicitly call one of the node insert methods.

According to the W3C Extensible Markup Language (XML) 1.0 recommendation (www.w3.org/TR/1998/REC-xml-19980210), Comment nodes are only allowed within Document, Element and EntityReference nodes, when the EntityReference node is not a child of an Attribute node.

The following example creates a comment and adds it to an 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);

  }
}
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

int main()
{
    XmlDocument* doc = new XmlDocument();
    doc->LoadXml(S"<book genre='novel' ISBN='1-861001-57-5'><title>Pride And Prejudice</title></book>");

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

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

    Console::WriteLine(S"Display the modified XML...");        
    doc->Save(Console::Out);
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft