XmlReaderSettings.IgnoreComments Property

Gets or sets a value indicating whether to ignore comments.

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

public bool IgnoreComments { get; set; }

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.
XmlReaderSettings settings = new XmlReaderSettings();
settings.IgnoreComments = true;
settings.IgnoreProcessingInstructions = true;
settings.IgnoreWhitespace = true;


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft