XmlWriter クラス

定義

名前空間:

System.Xml

アセンブリ:

System.Xml.ReaderWriter.dll

ソース:

XmlWriter.cs

XML データを含むストリームまたはファイルを生成するための高速でキャッシュされていない順方向専用の方法を提供するライターを表します。

public ref class XmlWriter abstract : IAsyncDisposable, IDisposable

public abstract class XmlWriter : IAsyncDisposable, IDisposable

type XmlWriter = class
    interface IAsyncDisposable
    interface IDisposable

Public MustInherit Class XmlWriter
Implements IAsyncDisposable, IDisposable

継承

Object

XmlWriter

派生

System.Xml.XmlDictionaryWriter

System.Xml.XmlTextWriter

System.Xml.Xsl.Runtime.XmlQueryOutput

実装

IDisposable IAsyncDisposable

例

次のコード例は、非同期 API を使用して XML を生成する方法を示しています。

async Task TestWriter(Stream stream)
{
    XmlWriterSettings settings = new XmlWriterSettings();
    settings.Async = true;

    using (XmlWriter writer = XmlWriter.Create(stream, settings)) {
        await writer.WriteStartElementAsync("pf", "root", "http://ns");
        await writer.WriteStartElementAsync(null, "sub", null);
        await writer.WriteAttributeStringAsync(null, "att", null, "val");
        await writer.WriteStringAsync("text");
        await writer.WriteEndElementAsync();
        await writer.WriteProcessingInstructionAsync("pName", "pValue");
        await writer.WriteCommentAsync("cValue");
        await writer.WriteCDataAsync("cdata value");
        await writer.WriteEndElementAsync();
        await writer.FlushAsync();
    }
}

注釈

この API の詳細については、「XmlWriterの補足 API 解説 参照してください。

コンストラクター

XmlWriter()

XmlWriter クラスの新しいインスタンスを初期化します。

プロパティ

Settings	この XmlWriter インスタンスの作成に使用する XmlWriterSettings オブジェクトを取得します。
WriteState	派生クラスでオーバーライドされると、ライターの状態を取得します。
XmlLang	派生クラスでオーバーライドされると、現在の xml:lang スコープを取得します。
XmlSpace	派生クラスでオーバーライドされると、現在の xml:space スコープを表す XmlSpace を取得します。

メソッド

Close()	派生クラスでオーバーライドされると、このストリームと基になるストリームを閉じます。
Create(Stream)	指定したストリームを使用して新しい XmlWriter インスタンスを作成します。
Create(Stream, XmlWriterSettings)	ストリームと XmlWriterSettings オブジェクトを使用して、新しい XmlWriter インスタンスを作成します。
Create(String)	指定したファイル名を使用して新しい XmlWriter インスタンスを作成します。
Create(String, XmlWriterSettings)	ファイル名と XmlWriterSettings オブジェクトを使用して、新しい XmlWriter インスタンスを作成します。
Create(StringBuilder)	指定した StringBuilderを使用して新しい XmlWriter インスタンスを作成します。
Create(StringBuilder, XmlWriterSettings)	StringBuilder オブジェクトと XmlWriterSettings オブジェクトを使用して、新しい XmlWriter インスタンスを作成します。
Create(TextWriter)	指定した TextWriterを使用して新しい XmlWriter インスタンスを作成します。
Create(TextWriter, XmlWriterSettings)	TextWriter オブジェクトと XmlWriterSettings オブジェクトを使用して、新しい XmlWriter インスタンスを作成します。
Create(XmlWriter)	指定した XmlWriter オブジェクトを使用して、新しい XmlWriter インスタンスを作成します。
Create(XmlWriter, XmlWriterSettings)	指定した XmlWriter オブジェクトと XmlWriterSettings オブジェクトを使用して、新しい XmlWriter インスタンスを作成します。
Dispose()	XmlWriter クラスの現在のインスタンスで使用されているすべてのリソースを解放します。
Dispose(Boolean)	XmlWriter によって使用されるアンマネージ リソースを解放し、必要に応じてマネージド リソースを解放します。
DisposeAsync()	アンマネージ リソースの解放、解放、またはリセットに関連するアプリケーション定義タスクを非同期的に実行します。
DisposeAsyncCore()	マネージド リソースの解放、解放、またはリセットに関連するアプリケーション定義タスクを非同期的に実行します。
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
Flush()	派生クラスでオーバーライドされると、バッファー内にあるものを基になるストリームにフラッシュし、基になるストリームもフラッシュします。
FlushAsync()	バッファー内にあるものを基になるストリームに非同期的にフラッシュし、基になるストリームもフラッシュします。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
LookupPrefix(String)	派生クラスでオーバーライドされた場合は、名前空間 URI の現在の名前空間スコープで定義されている最も近いプレフィックスを返します。
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
WriteAttributes(XmlReader, Boolean)	派生クラスでオーバーライドされると、XmlReader内の現在の位置にあるすべての属性を書き出します。
WriteAttributesAsync(XmlReader, Boolean)	XmlReader内の現在の位置にあるすべての属性を非同期に書き出します。
WriteAttributeString(String, String)	派生クラスでオーバーライドされると、指定したローカル名と値を持つ属性を書き出します。
WriteAttributeString(String, String, String)	派生クラスでオーバーライドされると、指定したローカル名、名前空間 URI、および値を持つ属性を書き込みます。
WriteAttributeString(String, String, String, String)	派生クラスでオーバーライドされると、指定したプレフィックス、ローカル名、名前空間 URI、および値を持つ属性を書き込みます。
WriteAttributeStringAsync(String, String, String, String)	指定したプレフィックス、ローカル名、名前空間 URI、および値を使用して、属性を非同期に書き込みます。
WriteBase64(Byte[], Int32, Int32)	派生クラスでオーバーライドされると、指定したバイナリ バイトを Base64 としてエンコードし、結果のテキストを書き出します。
WriteBase64Async(Byte[], Int32, Int32)	指定したバイナリ バイトを Base64 として非同期にエンコードし、結果のテキストを書き込みます。
WriteBinHex(Byte[], Int32, Int32)	派生クラスでオーバーライドされると、指定したバイナリ バイトを BinHex としてエンコードし、結果のテキストを書き込みます。
WriteBinHexAsync(Byte[], Int32, Int32)	指定したバイナリ バイトを BinHex として非同期的にエンコードし、結果のテキストを書き込みます。
WriteCData(String)	派生クラスでオーバーライドされると、<![CDATA[...]]指定したテキストを含むブロック> します。
WriteCDataAsync(String)	<を非同期的に書き出します。[CDATA[...]]指定したテキストを含むブロック> します。
WriteCharEntity(Char)	派生クラスでオーバーライドされると、指定した Unicode 文字値に対して文字エンティティが強制的に生成されます。
WriteCharEntityAsync(Char)	指定した Unicode 文字値に対して文字エンティティを非同期的に生成します。
WriteChars(Char[], Int32, Int32)	派生クラスでオーバーライドされると、一度に 1 つのバッファーにテキストを書き込みます。
WriteCharsAsync(Char[], Int32, Int32)	テキストを一度に 1 つのバッファーに非同期で書き込みます。
WriteComment(String)	派生クラスでオーバーライドされると、指定したテキストを含むコメント <!--...--> 書き込みます。
WriteCommentAsync(String)	指定したテキストを含むコメント <!--...--> を非同期に書き出します。
WriteDocType(String, String, String, String)	派生クラスでオーバーライドされると、指定した名前と省略可能な属性を使用して DOCTYPE 宣言を書き込みます。
WriteDocTypeAsync(String, String, String, String)	指定した名前と省略可能な属性を使用して、DOCTYPE 宣言を非同期に書き込みます。
WriteElementString(String, String)	指定したローカル名と値を持つ要素を書き込みます。
WriteElementString(String, String, String)	指定したローカル名、名前空間 URI、および値を持つ要素を書き込みます。
WriteElementString(String, String, String, String)	指定したプレフィックス、ローカル名、名前空間 URI、および値を持つ要素を書き込みます。
WriteElementStringAsync(String, String, String, String)	指定したプレフィックス、ローカル名、名前空間 URI、および値を持つ要素を非同期に書き込みます。
WriteEndAttribute()	派生クラスでオーバーライドされた場合は、前の WriteStartAttribute(String, String) 呼び出しを閉じます。
WriteEndAttributeAsync()	前の WriteStartAttribute(String, String) 呼び出しを非同期的に閉じます。
WriteEndDocument()	派生クラスでオーバーライドされると、開いている要素または属性をすべて閉じ、ライターを Start 状態に戻します。
WriteEndDocumentAsync()	開いている要素または属性を非同期的に閉じ、ライターを Start 状態に戻します。
WriteEndElement()	派生クラスでオーバーライドされると、1 つの要素を閉じ、対応する名前空間スコープをポップします。
WriteEndElementAsync()	1 つの要素を非同期的に閉じ、対応する名前空間スコープをポップします。
WriteEntityRef(String)	派生クラスでオーバーライドされると、エンティティ参照を &name;として書き出します。
WriteEntityRefAsync(String)	エンティティ参照を &name;として非同期に書き出します。
WriteFullEndElement()	派生クラスでオーバーライドされると、1 つの要素を閉じ、対応する名前空間スコープをポップします。
WriteFullEndElementAsync()	1 つの要素を非同期的に閉じ、対応する名前空間スコープをポップします。
WriteName(String)	派生クラスでオーバーライドされた場合は、指定した名前を書き込み、W3C XML 1.0 の推奨事項 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name) に従って有効な名前であることを確認します。
WriteNameAsync(String)	指定した名前を非同期に書き込み、W3C XML 1.0 の推奨事項 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name) に従って有効な名前であることを確認します。
WriteNmToken(String)	派生クラスでオーバーライドされた場合は、W3C XML 1.0 の推奨事項 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name) に従って有効な NmToken であることを確認して、指定した名前を書き出します。
WriteNmTokenAsync(String)	指定した名前を非同期に書き込み、W3C XML 1.0 の推奨事項 (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name) に従って有効な NmToken であることを確認します。
WriteNode(XmlReader, Boolean)	派生クラスでオーバーライドされると、リーダーからライターにすべてをコピーし、リーダーを次の兄弟の先頭に移動します。
WriteNode(XPathNavigator, Boolean)	XPathNavigator オブジェクトからライターにすべてをコピーします。 XPathNavigator の位置は変更されません。
WriteNodeAsync(XmlReader, Boolean)	リーダーからライターにすべてを非同期にコピーし、リーダーを次の兄弟の先頭に移動します。
WriteNodeAsync(XPathNavigator, Boolean)	XPathNavigator オブジェクトからライターにすべてを非同期にコピーします。 XPathNavigator の位置は変更されません。
WriteProcessingInstruction(String, String)	派生クラスでオーバーライドされると、次のように、名前とテキストの間にスペースを入れた処理命令を書き出します:<?name text?>.
WriteProcessingInstructionAsync(String, String)	次のように、名前とテキストの間にスペースを入れ、処理命令 <非同期に書き出します。>.
WriteQualifiedName(String, String)	派生クラスでオーバーライドされると、名前空間修飾名を書き出します。 このメソッドは、指定された名前空間のスコープ内にあるプレフィックスを検索します。
WriteQualifiedNameAsync(String, String)	名前空間修飾名を非同期的に書き込みます。 このメソッドは、指定された名前空間のスコープ内にあるプレフィックスを検索します。
WriteRaw(Char[], Int32, Int32)	派生クラスでオーバーライドされると、文字バッファーから生のマークアップを手動で書き込みます。
WriteRaw(String)	派生クラスでオーバーライドされると、文字列から生のマークアップを手動で書き込みます。
WriteRawAsync(Char[], Int32, Int32)	文字バッファーから生のマークアップを手動で非同期に書き込みます。
WriteRawAsync(String)	文字列から生のマークアップを手動で非同期に書き込みます。
WriteStartAttribute(String)	指定したローカル名を持つ属性の先頭を書き込みます。
WriteStartAttribute(String, String)	指定したローカル名と名前空間 URI を使用して、属性の先頭を書き込みます。
WriteStartAttribute(String, String, String)	派生クラスでオーバーライドされると、指定したプレフィックス、ローカル名、および名前空間 URI を持つ属性の先頭を書き込みます。
WriteStartAttributeAsync(String, String, String)	指定したプレフィックス、ローカル名、および名前空間 URI を使用して、属性の先頭を非同期に書き込みます。
WriteStartDocument()	派生クラスでオーバーライドされた場合は、バージョン "1.0" で XML 宣言を書き込みます。
WriteStartDocument(Boolean)	派生クラスでオーバーライドされた場合は、バージョン "1.0" とスタンドアロン属性を使用して XML 宣言を書き込みます。
WriteStartDocumentAsync()	バージョン "1.0" で XML 宣言を非同期に書き込みます。
WriteStartDocumentAsync(Boolean)	バージョン "1.0" とスタンドアロン属性を使用して XML 宣言を非同期に書き込みます。
WriteStartElement(String)	派生クラスでオーバーライドされると、指定したローカル名を持つ開始タグを書き出します。
WriteStartElement(String, String)	派生クラスでオーバーライドされると、指定した開始タグを書き込み、指定された名前空間に関連付けます。
WriteStartElement(String, String, String)	派生クラスでオーバーライドされると、指定した開始タグを書き込み、指定された名前空間とプレフィックスに関連付けます。
WriteStartElementAsync(String, String, String)	指定した開始タグを非同期に書き込み、指定された名前空間とプレフィックスに関連付けます。
WriteString(String)	派生クラスでオーバーライドされると、指定されたテキスト コンテンツを書き込みます。
WriteStringAsync(String)	指定されたテキスト コンテンツを非同期的に書き込みます。
WriteSurrogateCharEntity(Char, Char)	派生クラスでオーバーライドされると、サロゲート文字ペアのサロゲート文字エンティティを生成して書き込みます。
WriteSurrogateCharEntityAsync(Char, Char)	サロゲート文字ペアのサロゲート文字エンティティを非同期的に生成して書き込みます。
WriteValue(Boolean)	Boolean 値を書き込みます。
WriteValue(DateTime)	DateTime 値を書き込みます。
WriteValue(DateTimeOffset)	DateTimeOffset 値を書き込みます。
WriteValue(Decimal)	Decimal 値を書き込みます。
WriteValue(Double)	Double 値を書き込みます。
WriteValue(Int32)	Int32 値を書き込みます。
WriteValue(Int64)	Int64 値を書き込みます。
WriteValue(Object)	オブジェクト値を書き込みます。
WriteValue(Single)	単精度浮動小数点数を書き込みます。
WriteValue(String)	String 値を書き込みます。
WriteWhitespace(String)	派生クラスでオーバーライドされると、指定された空白を書き出します。
WriteWhitespaceAsync(String)	指定された空白を非同期的に書き出します。

拡張メソッド

ConfigureAwait(IAsyncDisposable, Boolean)

非同期破棄から返されるタスクの待機を実行する方法を構成します。

こちらもご覧ください

• XML ドキュメントとデータ の