XmlReaderSettings.IgnoreComments Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether to ignore comments.

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

Public Property IgnoreComments As Boolean

Property Value

Type: System.Boolean

true to ignore comments; otherwise false. The default is false.

Setting this property to true can result in multiple contiguous text nodes being returned from the reader. This does not affect validation.

The following creates a settings object that can be used to construct a reader that strips processing instructions, comments, and insignificant white space.

' Set the reader settings.
Dim settings as XmlReaderSettings = new XmlReaderSettings()
settings.IgnoreComments = true
settings.IgnoreProcessingInstructions = true
settings.IgnoreWhitespace = true

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: