Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

XmlTextReader.EntityHandling Property

.NET Framework 2.0

Note: This property is new in the .NET Framework version 2.0.

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

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

C#
C++
VB
Copy 
public EntityHandling EntityHandling { get; set; }
J#
Copy 
/** @property */
public EntityHandling get_EntityHandling ()

/** @property */
public void set_EntityHandling (EntityHandling value)
JScript
Copy 
public function get EntityHandling () : EntityHandling

public function set EntityHandling (value : EntityHandling)

Property Value

One of the EntityHandling values. If no EntityHandling is specified, it defaults to EntityHandling.ExpandCharEntities.
NoteNote

In the Microsoft .NET Framework version 2.0 release, the recommended practice is to create XmlReader instances using the System.Xml.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:

Copy 
<!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

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ