XmlDocument.CreateComment Method (String)

 

Creates an XmlComment containing the specified data.

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

Public Overridable Function CreateComment (
	data As String
) As XmlComment

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.

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top
Show: