.NET Framework Class Library
XmlReaderSettings.IgnoreComments Property
Gets or sets a value indicating whether to ignore comments.
Assembly: System.Xml (in System.Xml.dll)
Syntax
Visual Basic
Public Property IgnoreComments As Boolean Get Set
C#
public bool IgnoreComments { get; set; }
Visual C++
public: property bool IgnoreComments { bool get (); void set (bool value); }
F#
member IgnoreComments : bool with get, set
Remarks
Setting this property to true can result in multiple contiguous text nodes being returned from the reader. This does not affect validation.
Examples
The following creates a settings object that can be used to construct a reader that strips processing instructions, comments, and insignificant white space.
Visual Basic
' Set the reader settings. Dim settings as XmlReaderSettings = new XmlReaderSettings() settings.IgnoreComments = true settings.IgnoreProcessingInstructions = true settings.IgnoreWhitespace = true
C#
// Set the reader settings. XmlReaderSettings settings = new XmlReaderSettings(); settings.IgnoreComments = true; settings.IgnoreProcessingInstructions = true; settings.IgnoreWhitespace = true;
Visual C++
// Set the reader settings. XmlReaderSettings^ settings = gcnew XmlReaderSettings; settings->IgnoreComments = true; settings->IgnoreProcessingInstructions = true; settings->IgnoreWhitespace = true;
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryPlatforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also