XmlWriterSettings.Encoding プロパティ

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

XmlWriterSettings.Encoding プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

使用するテキスト エンコーディングを取得または設定します。

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

Visual Basic (宣言)

Public Property Encoding As
 Encoding

Visual Basic (使用法)

Dim instance As XmlWriterSettings
Dim value As Encoding

value = instance.Encoding

instance.Encoding = value

C#

public Encoding Encoding { get; set;
 }

C++

public:
property Encoding^ Encoding {
    Encoding^ get ();
    void set (Encoding^ value);
}

J#

/** @property */
public Encoding get_Encoding ()

/** @property */
public void set_Encoding (Encoding value)

JScript

public function get Encoding
 () : Encoding

public function set Encoding
 (value : Encoding)

プロパティ値
使用するテキスト エンコーディング。既定値は Encoding.UTF8 です。

解説

このプロパティは、ストリームにテキストの内容を出力する、XmlWriter のインスタンスにのみ適用されます。それ以外の場合、この設定は無視されます。XmlWriter は、文字単位ではなくバッファ単位で文字をエンコードします。エンコーディング エラーがまったく発生しなかった場合に、Flush メソッドを呼び出すと、例外がスローされます。

セキュリティに関するメモ
信頼関係のないソースからは Encoding オブジェクトを受け入れないようにしてください。

使用例

XML フラグメントをメモリ ストリームに書き込む例を次に示します。

Visual Basic

Dim settings As XmlWriterSettings = New
 XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new
 MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm,
 settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additonal processing on the stream.

C#

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additonal processing on the stream.

プラットフォーム

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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
XmlWriterSettings クラス
XmlWriterSettings メンバ
System.Xml 名前空間
その他の技術情報
XML ライタの作成