XmlTextWriter.WriteCharEntity メソッド

.NET Framework クラス ライブラリ リファレンス

XmlTextWriter.WriteCharEntity メソッド

指定した Unicode 文字値の文字エンティティを強制的に生成します。

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Overrides Sub WriteCharEntity
 ( _
    ch As Char _
)

Visual Basic (使用法)

Dim instance As XmlTextWriter
Dim ch As Char

instance.WriteCharEntity(ch)

C#

public override void WriteCharEntity (
    char ch
)

C++

public:
virtual void WriteCharEntity (
    wchar_t ch
) override

J#

public void WriteCharEntity (
    char ch
)

JScript

public override function WriteCharEntity (
    ch : char
)

パラメータ

ch

文字エンティティを生成する対象の Unicode 文字。

例外

例外の種類	条件
ArgumentException	文字がサロゲート ペアの文字範囲、つまり 0xd800 - 0xdfff 内にあります。この範囲内にない場合、テキストは非整形式の XML ドキュメントになります。
InvalidOperationException	WriteState が Closed です。

解説

メモ
Microsoft .NET Framework version 2.0 リリースでは、System.Xml.XmlWriter.Create メソッドと XmlWriterSettings クラスを使用して XmlWriter インスタンスを作成することをお勧めします。これにより、このリリースで導入されたすべての新機能を十分に活用できます。詳細については、「XML ライタの作成」を参照してください。

このメソッドは、Unicode 文字を 16 進文字エンティティの参照形式で書き込みます。

使用例

WriteCharEntity メソッドを使用して、電子メール アドレスを書き込む例を次に示します。

Visual Basic

Imports System
Imports System.Xml

public class Sample 
 
  public shared sub Main()
 
   
    Dim writer as XmlTextWriter = nothing
     
      try 
    
        writer = new XmlTextWriter (Console.Out)
 
        ' Write an element.
        writer.WriteStartElement("address")
     
        ' Write an e-mail address using entities
        ' for the @ and . characters.
        writer.WriteString("someone")
        writer.WriteCharEntity("@"c)
        writer.WriteString("example")
        writer.WriteCharEntity("."c)
        writer.WriteString("com")
        writer.WriteEndElement()        
 
    finally 
      ' Close the writer.
      if not writer is nothing
        writer.Close()
      end if
    end try 

  end sub
end class

C#

using System;
using System.Xml;

public class Sample {
 
  public static void Main()
 {
   
    XmlTextWriter writer = null;
     
      try {
    
        writer = new XmlTextWriter (Console.Out);
 
        // Write an element.
        writer.WriteStartElement("address");
     
        // Write an e-mail address using entities
        // for the @ and . characters.
        writer.WriteString("someone");
        writer.WriteCharEntity('@');
        writer.WriteString("example");
        writer.WriteCharEntity('.');
        writer.WriteString("com");
        writer.WriteEndElement();
 
    }        
 
    finally {
      // Close the writer.
      if (writer != null)
        writer.Close();
    } 
  }
}

C++

#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;
int main()
{
   XmlTextWriter^ writer = nullptr;
   try
   {
      writer = gcnew XmlTextWriter( Console::Out );
      
      // Write an element.
      writer->WriteStartElement( "address" );
      
      // Write an e-mail address using entities
      // for the @ and . characters.
      writer->WriteString( "someone" );
      writer->WriteCharEntity( '@' );
      writer->WriteString( "example" );
      writer->WriteCharEntity( '.' );
      writer->WriteString( "com" );
      writer->WriteEndElement();
   }
   finally
   {
      
      // Close the writer.
      if ( writer != nullptr )
            writer->Close();
   }

}

J#

import System.*;
import System.Xml.*;

public class Sample
{
    public static void main(String[]
 args)
    {
        XmlTextWriter writer = null;

        try {
            writer = new XmlTextWriter(Console.get_Out());

            // Write an element.
            writer.WriteStartElement("address");

            // Write an e-mail address using entities
            // for the @ and. characters.
            writer.WriteString("someone");
            writer.WriteCharEntity('@');
            writer.WriteString("example");
            writer.WriteCharEntity('.');
            writer.WriteString("com");
            writer.WriteEndElement();
        } 
        finally {
            // Close the writer.
            if (writer != null) {
                writer.Close();
            }
        }
    } //main
} //Sample

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlTextWriter クラス
XmlTextWriter メンバ
System.Xml 名前空間