.NET Framework Class Library
XmlTextWriter..::.WriteString Method

Writes the given text content.

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

Visual Basic (Declaration)
Public Overrides Sub WriteString ( _
    text As String _
)
Visual Basic (Usage)
Dim instance As XmlTextWriter
Dim text As String

instance.WriteString(text)
C#
public override void WriteString(
    string text
)
Visual C++
public:
virtual void WriteString(
    String^ text
) override
JScript
public override function WriteString(
    text : String
)

Parameters

text
Type: System..::.String
Text to write.
Exceptions

ExceptionCondition
ArgumentException

The text string contains an invalid surrogate pair.

Remarks

NoteNote:

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.

WriteString does the following

  • The characters &, <, and > are replaced with &amp;, &lt;, and &gt;, respectively.

  • Character values in the range 0x-0x1F (excluding white space characters 0x9, 0xA, and 0xD) are replaced with numeric character entities (&#0; through &#0x1F).

  • If WriteString is called in the context of an attribute value, double and single quotes are replaced with &quot; and &apos; respectively.

For example, this input string test<item>test is written as

 test&lt;item&gt;test

If text is either nullNothingnullptra null reference (Nothing in Visual Basic) or String.Empty, this method writes a text node with no data content.

Examples

The following example writes an XML fragment.

Visual Basic
Option Explicit
Option Strict

Imports System
Imports System.IO
Imports System.Xml

Public Class Sample

    Public Shared Sub Main()
        'Create a writer to write XML to the console.
        Dim writer As XmlTextWriter = Nothing
        writer = New XmlTextWriter(Console.Out)

        'Use indentation for readability.
        writer.Formatting = Formatting.Indented
        writer.Indentation = 4

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

        'Write the title element.
        writer.WriteStartElement("title")
        writer.WriteString("Pride And Prejudice")
        writer.WriteEndElement()

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

        'Write the XML to file and close the writer.
        writer.Close()
    End Sub 'Main 
End Class 'Sample
C#
using System;
using System.IO;
using System.Xml;

public class Sample
{

  public static void Main()
  {
     //Create a writer to write XML to the console.
     XmlTextWriter writer = null;
     writer = new XmlTextWriter (Console.Out);

     //Use indentation for readability.
     writer.Formatting = Formatting.Indented;
     writer.Indentation = 4;

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

     //Write the title element.
     writer.WriteStartElement("title");
     writer.WriteString("Pride And Prejudice");
     writer.WriteEndElement();

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

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

  }

}
Visual C++
#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{

   //Create a writer to write XML to the console.
   XmlTextWriter^ writer = nullptr;
   writer = gcnew XmlTextWriter( Console::Out );

   //Use indentation for readability.
   writer->Formatting = Formatting::Indented;
   writer->Indentation = 4;

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

   //Write the title element.
   writer->WriteStartElement( "title" );
   writer->WriteString( "Pride And Prejudice" );
   writer->WriteEndElement();

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

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

CPP_OLD
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

int main()
{
     //Create a writer to write XML to the console.
     XmlTextWriter* writer = 0;
     writer = new XmlTextWriter (Console::Out);

     //Use indentation for readability.
     writer->Formatting = Formatting::Indented;
     writer->Indentation = 4;

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

     //Write the title element.
     writer->WriteStartElement(S"title");
     writer->WriteString(S"Pride And Prejudice");
     writer->WriteEndElement();

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

     //Write the XML to file and close the writer.
     writer->Close();  

}
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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Tags :


Page view tracker