XmlReaderSettings.CheckCharacters Property

Definition

Gets or sets a value indicating whether to do character checking.

public:
 property bool CheckCharacters { bool get(); void set(bool value); };
public bool CheckCharacters { get; set; }
member this.CheckCharacters : bool with get, set
Public Property CheckCharacters As Boolean

Property Value

true to do character checking; otherwise false. The default is true.

Remarks

This property instructs the XML reader to check characters in the XML data it's reading and throw an XmlException if any characters are outside the range of legal XML characters. When character checking is enabled, you are ensured the following:

  • Characters are within the range of legal XML characters, as defined by the 2.2 Characters section of the W3C XML 1.0 Recommendation.

  • All XML names are valid, as defined by the 2.3 Common Syntactic Constructs section of the W3C XML 1.0 Recommendation.

When this property is set to true, which is the default setting, an XmlException exception is thrown if the XML file contains illegal characters or invalid XML names (for example, an element name starts with a number).

If the XmlReader is processing text data, it always checks that the XML names and text content are valid, regardless of the property setting. Setting CheckCharacters to false turns off character checking for character entity references.

Applies to