0 out of 4 rated this helpful - Rate this topic

XmlWriter.WriteElementString Method (String, String)

.NET Framework 4

Other Versions

Writes an element with the specified local name and value.

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

Syntax

C++

Copy

public void WriteElementString(
	string localName,
	string value
)

Parameters

localName: Type: System.String
The local name of the element.

value: Type: System.String
The value of the element.

Exceptions

Exception	Condition
ArgumentException	The localName value is null or an empty string. -or- The parameter values are not valid.
EncoderFallbackException	There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.

Exception

Condition

ArgumentException

The localName value is null or an empty string.

-or-

The parameter values are not valid.

EncoderFallbackException

There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.

Examples

The following example uses several write methods to create an XML fragment.

C++

Copy


using System;
using System.IO;
using System.Xml;

 public class Sample
 {
   private const string m_Document = "sampledata.xml";

   public static void Main() {

      XmlWriter writer = null;

      try {

        XmlWriterSettings settings = new XmlWriterSettings();
        settings.Indent = true;
        writer = XmlWriter.Create (m_Document, settings);

        writer.WriteComment("sample XML fragment");

        // Write an element (this one is the root).
        writer.WriteStartElement("book");

        // Write the namespace declaration.
        writer.WriteAttributeString("xmlns", "bk", null, "urn:samples");

        // Write the genre attribute.
        writer.WriteAttributeString("genre", "novel");

        // Write the title.
        writer.WriteStartElement("title");
        writer.WriteString("The Handmaid's Tale");
        writer.WriteEndElement();

        // Write the price.
        writer.WriteElementString("price", "19.95");

        // Lookup the prefix and write the ISBN element.
        string prefix = writer.LookupPrefix("urn:samples");
        writer.WriteStartElement(prefix, "ISBN", "urn:samples");
        writer.WriteString("1-861003-78");
        writer.WriteEndElement();

        // Write the style element (shows a different way to handle prefixes).
        writer.WriteElementString("style", "urn:samples", "hardcover");

        // Write the close tag for the root element.
        writer.WriteEndElement();

        // Write the XML to file and close the writer.
        writer.Flush();
        writer.Close();
      }

      finally {
        if (writer != null)
           writer.Close();
     } 
   }

 }

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Platforms

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.

Reference

XmlWriter Class

WriteElementString Overload

System.Xml Namespace

Other Resources

Writing XML with the XmlWriter

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

WriteElementString Sample using PowerShell

<#
.SYNOPSIS
    This script uses XMLWriter to write an XML Element
.DESCRIPTION
    This script creates and uses and XML writer to write an 
    XML Element
.NOTES
    File Name  : Write-XxmElementString.ps1
    Author     : Thomas Lee - tfl@psp.co.uk
    Requires   : PowerShell Version 2.0
.LINK
    This script posted to:
        http://www.pshscripts.blogspot.com
    MSDN Sample posted at:
        http://msdn.microsoft.com/en-us/library/aex0e7zs.aspx
.EXAMPLE
    PSH [C:\foo]: .\Write-XMLElementString.ps1'
    <orderID>1-456-ab</orderID><orderID>2-36-00a</orderID>
#>
# Create new XMLWriter settings
$settings = new-object System.Xml.XmlWriterSettings
$settings.OmitXmlDeclaration = $true
$settings.ConformanceLevel = 'Fragment'
$settings.CloseOutput = $false;

# Create the XmlWriter object and write some content.
#$strm = new-object system.io.MemoryStream
$writer = [system.xml.XmlWriter]::Create("c:\foo\data.xml", $settings)
$writer.WriteElementString("orderID", "1-456-ab");
$writer.WriteElementString("orderID", "2-36-00a");
$writer.Flush();
$writer.Close();

# Display data
cat .\data.xml
# End Script

History

5/21/2010
Thomas Lee