XmlWriter クラス

定義

名前空間:

System.Xml

アセンブリ:

System.Xml.ReaderWriter.dll

Source:

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)	指定された名前とオプション属性を使用して DOC 宣言を非同期に書き込みます。
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)	名前とテキストの間にスペースがある処理命令を、次のように非同期的に書き込みます: <?name text?>。
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 ドキュメントと XML データ