The System.Xml.XmlComment Class

Supported Versions

Public Members

Overview

This specialized class simply represents a standard XML comment section (an area within an XML documented bracketed by <!-- and -->). It is a sub-class of XMLCharacterData and inherits many of its methods. Use this class to add, modify, or delete comment sections within XML documents.

Example (VB.NET): How to create and assign a value to an XMLComment object, and how to insert and remove this object from an XML document.

The example provided here loads an XML construct without any comments. It then inserts a sample comment using the XMLDocument.CreateComment and XMLElement.AppendChild methods. It captures the contents of the document in a variable, but then removes the comment it just added, using the RemoveChild method. It concludes by displaying both variations of the construct.

        Dim objDocument As New System.Xml.XmlDocument

        Dim objComment As System.Xml.XmlComment

        Dim objElement As System.Xml.XmlElement

        Dim strValue As String

        objDocument.LoadXml("<sampleElement1><sampleElement2>We are demonstrating XML.</sampleElement2></sampleElement1>")

        objComment = objDocument.CreateComment("Sample text for an XML comment.")

        objElement = objDocument.DocumentElement()

        objElement.AppendChild(objComment)

        strValue = "Before: " & objDocument.InnerXml() & CrLf & CrLf

        objElement.RemoveChild(objComment)

        strValue &= "After: " & objDocument.InnerXml() & CrLf & CrLf

        TextBox1.Text = strValue