XmlTextWriter::WriteString Method (String^)

 

Writes the given text content.

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

public:
virtual void WriteString(
	String^ text
) override

Parameters

text
Type: System::String^

Text to write.

Exception Condition
ArgumentException

The text string contains an invalid surrogate pair.

System_CAPS_noteNote

Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter::Create method and the XmlWriterSettings class to take advantage of new functionality.

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 null or String.Empty, this method writes a text node with no data content.

The following example writes an XML fragment.

#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();
}

.NET Framework
Available since 1.1
Return to top
Show: