XmlWriter.WriteElementString 方法

定義

命名空間:

System.Xml

組件:

System.Xml.ReaderWriter.dll

寫入包含字串值的項目。

多載

WriteElementString(String, String)	寫入具有指定之區域名稱和值的項目。
WriteElementString(String, String, String)	寫入具有指定之區域名稱、命名空間 URI 和值的項目。
WriteElementString(String, String, String, String)	寫入具有指定的前置詞、區域名稱、命名空間 URI 和值的項目。

備註

如需這個方法的非同步版本，請參閱 WriteElementStringAsync 。

WriteElementString(String, String)

來源:

XmlWriter.cs

寫入具有指定之區域名稱和值的項目。

C#

public void WriteElementString (string localName, string? value);

參數

localName

String

項目的本機名稱。

value

String

項目的值。

例外狀況

ArgumentException

localName 值為 null 或空字串。

-或-

參數值無效。

EncoderFallbackException

緩衝區中有一個字元，其為有效的 XML 字元，但對輸出編碼而言無效。 比方說如果輸出的編碼方式為 ASCII，您應該在項目與屬性名稱中只使用範圍從 0 至 127 的字元。 無效的字元可能是在這個方法的引數中，或在先前已寫入至緩衝區的方法的引數中。 字元實體參考會盡可能逸出這類字元 (比方說在文字節點或屬性值中)。 不過，在項目與屬性名稱、註解、處理指示或 CDATA 區段中不允許字元實體參考。

InvalidOperationException

在先前的非同步作業完成前呼叫了 XmlWriter 方法。 在此情況下，會擲回 InvalidOperationException 與「非同步作業已經在進行中」的訊息。

範例

下列範例使用數個寫入方法來建立 XML 片段。

C#

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

備註

如需這個方法的非同步版本，請參閱 WriteElementStringAsync 。

WriteElementString(String, String, String)

來源:

XmlWriter.cs

寫入具有指定之區域名稱、命名空間 URI 和值的項目。

C#

public void WriteElementString (string localName, string? ns, string? value);

參數

localName

String

項目的本機名稱。

ns

String

與項目相關聯的命名空間 URI。

value

String

項目的值。

例外狀況

ArgumentException

localName 值為 null 或空字串。

-或-

參數值無效。

EncoderFallbackException

緩衝區中有一個字元，其為有效的 XML 字元，但對輸出編碼而言無效。 比方說如果輸出的編碼方式為 ASCII，您應該在項目與屬性名稱中只使用範圍從 0 至 127 的字元。 無效的字元可能是在這個方法的引數中，或在先前已寫入至緩衝區的方法的引數中。 字元實體參考會盡可能逸出這類字元 (比方說在文字節點或屬性值中)。 不過，在項目與屬性名稱、註解、處理指示或 CDATA 區段中不允許字元實體參考。

InvalidOperationException

在先前的非同步作業完成前呼叫了 XmlWriter 方法。 在此情況下，會擲回 InvalidOperationException 與「非同步作業已經在進行中」的訊息。

範例

下列範例使用數個寫入方法來建立 XML 片段。

C#

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

備註

如需這個方法的非同步版本，請參閱 WriteElementStringAsync 。

WriteElementString(String, String, String, String)

來源:

XmlWriter.cs

寫入具有指定的前置詞、區域名稱、命名空間 URI 和值的項目。

C#

public void WriteElementString (string? prefix, string localName, string? ns, string? value);

參數

prefix

String

項目的前置詞。

localName

String

項目的本機名稱。

ns

String

項目的命名空間 URI。

value

String

項目的值。

例外狀況

ArgumentException

localName 值為 null 或空字串。

-或-

參數值無效。

EncoderFallbackException

緩衝區中有一個字元，其為有效的 XML 字元，但對輸出編碼而言無效。 比方說如果輸出的編碼方式為 ASCII，您應該在項目與屬性名稱中只使用範圍從 0 至 127 的字元。 無效的字元可能是在這個方法的引數中，或在先前已寫入至緩衝區的方法的引數中。 字元實體參考會盡可能逸出這類字元 (比方說在文字節點或屬性值中)。 不過，在項目與屬性名稱、註解、處理指示或 CDATA 區段中不允許字元實體參考。

InvalidOperationException

在先前的非同步作業完成前呼叫了 XmlWriter 方法。 在此情況下，會擲回 InvalidOperationException 與「非同步作業已經在進行中」的訊息。

備註

如需這個方法的非同步版本，請參閱 WriteElementStringAsync 。