XmlTextWriter.WriteCharEntity Method
Forces the generation of a character entity for the specified Unicode character value.
Assembly: System.Xml (in System.Xml.dll)
| Exception | Condition |
|---|---|
| ArgumentException |
The character is in the surrogate pair character range, 0xd800 - 0xdfff; or the text would result in a non-well formed XML document. |
| InvalidOperationException |
The WriteState is Closed. |
Note
|
|---|
|
In the .NET Framework version 2.0 release, the recommended practice is to create XmlWriter instances using the XmlWriter.Create method and the XmlWriterSettings class. This allows you to take full advantage of all the new features introduced in this release. For more information, see Creating XML Writers. |
This method writes the Unicode character in hexadecimal character entity reference format.
The following example uses the WriteCharEntity method to write an e-mail address.
using System; using System.Xml; public class Sample { public static void Main() { XmlTextWriter writer = null; try { writer = new XmlTextWriter (Console.Out); // Write an element. writer.WriteStartElement("address"); // Write an e-mail address using entities // for the @ and . characters. writer.WriteString("someone"); writer.WriteCharEntity('@'); writer.WriteString("example"); writer.WriteCharEntity('.'); writer.WriteString("com"); writer.WriteEndElement(); } finally { // Close the writer. if (writer != null) writer.Close(); } } }
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.
