XmlWriter.WriteString(String) XmlWriter.WriteString(String) XmlWriter.WriteString(String) XmlWriter.WriteString(String) Method

定義

派生クラスでオーバーライドされると、指定したテキスト内容を書き込みます。When overridden in a derived class, writes the given text content.

public:
 abstract void WriteString(System::String ^ text);
public abstract void WriteString (string text);
abstract member WriteString : string -> unit
Public MustOverride Sub WriteString (text As String)

パラメーター

text
String String String String

書き込むテキスト。The text to write.

例外

テキスト文字列に、無効なサロゲート ペアが含まれています。The text string contains an invalid surrogate pair.

先行の非同期操作が完了する前に、XmlWriter メソッドが呼び出されました。An XmlWriter method was called before a previous asynchronous operation finished. この場合、「非同期操作が既に実行されています」というメッセージと共に InvalidOperationException がスローされます。In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

次の例では、XML ノードを書き込みます。The following example writes an XML node.

#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.
   XmlWriterSettings^ settings = gcnew XmlWriterSettings;
   settings->Indent = true;
   settings->OmitXmlDeclaration = true;
   XmlWriter^ writer = XmlWriter::Create( Console::Out, settings );
   
   // Write the book element.
   writer->WriteStartElement( L"book" );
   
   // Write the title element.
   writer->WriteStartElement( L"title" );
   writer->WriteString( L"Pride And Prejudice" );
   writer->WriteEndElement();
   
   // Write the close tag for the root element.
   writer->WriteEndElement();
   
   // Write the XML and close the writer.
   writer->Close();
   return 1;
}

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

public class Sample {
  
  public static void Main() {
  
     // Create a writer to write XML to the console.
     XmlWriterSettings settings = new XmlWriterSettings();
     settings.Indent = true;
     settings.OmitXmlDeclaration = true;
     XmlWriter writer = XmlWriter.Create(Console.Out, settings);

     // Write the book element.
     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 and close the writer.
     writer.Close();  

  }
}
Option Explicit
Option Strict

Imports System.IO
Imports System.Xml

Public Class Sample
    
  Public Shared Sub Main()

     ' Create a writer to write XML to the console.
     Dim settings As XmlWriterSettings = new XmlWriterSettings()
     settings.Indent = true
     settings.OmitXmlDeclaration = true
     Dim writer As XmlWriter = XmlWriter.Create(Console.Out, settings)

     ' Write the book element.
     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 and close the writer.
     writer.Close()

  End Sub
End Class

注釈

WriteString では次の処理が行われます。WriteString does the following:

  • 、、 &および< &amp; &lt;の各文字は、それぞれ、、 &gt;およびに置き換えられます。 >The characters &, <, and > are replaced with &amp;, &lt;, and &gt;, respectively.

  • を使用してXmlWriter Create作成されたの既定のArgumentException動作では、0x-0x1f (空白文字0x9、0xa、0xd を除く) で文字値を書き込もうとすると、がスローされます。The default behavior of an XmlWriter created using Create is to throw an ArgumentException when attempting to write character values in the range 0x-0x1F (excluding white space characters 0x9, 0xA, and 0xD). これらの無効な XML 文字は、 XmlWriterプロパティがCheckCharactersfalse設定されたを作成することによって記述できます。These invalid XML characters can be written by creating the XmlWriter with the CheckCharacters property set to false. このようにすると、文字が数字エンティティ (&#0; から & #0x1F) に置換されます。Doing so will result in the characters being replaced with numeric character entities (&#0; through &#0x1F). また、既定XmlTextWriterでは、 new演算子を使用して作成されたによって、無効な文字が数値文字エンティティに置き換えられます。Additionally, an XmlTextWriter created with the new operator will replace the invalid characters with numeric character entities by default.

メモXML を使用する多くのアプリケーションは無効な文字を処理するように設計されていないため、Microsoft では無効な XML 文字を記述することを推奨していません。Note Microsoft does not encourage the practice of writing invalid XML characters since many applications that consume XML are not designed to handle invalid characters.

  • 属性WriteString値のコンテキストでが呼び出された場合、二重引用符と単一引用符はそれぞれ&quot;&apos;に置き換えられます。If WriteString is called in the context of an attribute value, double and single quotes are replaced with &quot; and &apos; respectively.

たとえば、次の入力文字列test<item>testはとして書き込まれます。For example, this input string test<item>test is written out as

test&lt;item&gt;test  

textまたはnull のいずれかの場合、このメソッドはデータコンテンツのないテキストノードを書き込みます。String.EmptyIf text is either null or String.Empty, this method writes a text node with no data content.

このメソッドの非同期バージョンについてはWriteStringAsync、「」を参照してください。For the asynchronous version of this method, see WriteStringAsync.

適用対象