XmlTextReader.EntityHandling Property (System.Xml)

EntityHandling Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XmlTextReader..::.EntityHandling Property

Gets or sets a value that specifies how the reader handles entities.

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

Syntax

Visual Basic (Declaration)

Public Property EntityHandling As EntityHandling

Visual Basic (Usage)

Dim instance As XmlTextReader
Dim value As EntityHandling

value = instance.EntityHandling

instance.EntityHandling = value

public EntityHandling EntityHandling { get; set; }

Visual C++

public:
property EntityHandling EntityHandling {
    EntityHandling get ();
    void set (EntityHandling value);
}

JScript

public function get EntityHandling () : EntityHandling
public function set EntityHandling (value : EntityHandling)

Property Value

Type: System.Xml..::.EntityHandling
One of the EntityHandling values. If no EntityHandling is specified, it defaults to EntityHandling.ExpandCharEntities.

Remarks

Note:
In the .NET Framework version 2.0 release, the recommended practice is to create XmlReader instances using the XmlReader..::.Create method. This allows you to take full advantage of the new features introduced in this release. For more information, see Creating XML Readers.

This property can be changed on the fly and takes effect after the next Read call.

When EntityHandling is set to ExpandCharEntities, attribute values are only partially normalized. The reader normalizes each individual text node independently from the content of adjacent entity reference nodes.

To illustrate the difference between the entity handling modes consider the following XML:

<!DOCTYPE doc [<!ENTITY num "123">]>
    <doc> &#65; &num; </doc>

When EntityHandling is set to ExpandEntities the "doc" element node contains one text node with the expanded entity text:

Depth	Node type	Name	Value
1	Text		A 123

When EntityHandling is set to ExpandCharEntites, and WhitespaceHandling is set to Significant or All, the "doc" element expands the character entity and returns the general entity as a node:

Depth	Node type	Name	Value
1	Text		A
1	EntityReference	num
1	SignificantWhitespace

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

XmlTextReader Class

XmlTextReader Members

System.Xml Namespace

Other Resources

Reading XML with the XmlReader