XmlWriter.WriteValue メソッド

リファレンス

定義

名前空間:: System.Xml

アセンブリ:: System.Xml.ReaderWriter.dll

アセンブリ:: System.Xml.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

単一の単純型の値を書き込みます。

オーバーロード

WriteValue(Single)	単精度浮動小数点数を書き込みます。
WriteValue(Object)	オブジェクト値を書き込みます。
WriteValue(Int64)	Int64 値を書き込みます。
WriteValue(Int32)	Int32 値を書き込みます。
WriteValue(Double)	Double 値を書き込みます。
WriteValue(String)	String 値を書き込みます。
WriteValue(DateTimeOffset)	DateTimeOffset 値を書き込みます。
WriteValue(DateTime)	DateTime 値を書き込みます。
WriteValue(Boolean)	Boolean 値を書き込みます。
WriteValue(Decimal)	Decimal 値を書き込みます。

注釈

このメソッドは WriteValue 、共通言語ランタイム (CLR) の単純型指定値を受け取り、XML スキーマ定義言語 (XSD) データ型変換規則に従って文字列表現に変換し、メソッドを使用 WriteString して書き出します。これにより、単純型の値をパイプライン処理し、オブジェクト間XPathDocument XmlReaderでデータを渡すときの再解析オーバーヘッドを最小限に抑XmlWriterえることができます。この機能は、CLR 単純型とインスタンスを処理する XmlWriter 場合にも役立ちます。クラスのメソッドを WriteValue 使用して型指定されたデータを文字列値に変換する代わりに、 XmlConvert 型指定された値を書き込むメソッドを呼び出すことができます。

非同期操作の場合は、戻り値 WriteValue を文字列に変換し、メソッドを使用します WriteStringAsync 。

次の表は、CLR 型に対応する既定の XSD データ型を示しています。

CLR オブジェクトが IEnumerable、IList、ICollection などのリスト型の場合は、値型の配列として扱われます。

CLR 型	既定の XSD データ型
System.Boolean	xsd:boolean
System.Byte**	xsd:integer
System.Byte 配列	xsd:base64Binary
System.Char**	xsd:string
System.DateTime	xsd:dateTime
System.Decimal	xsd:decimal
System.Double	xsd:double
System.Int16**	xsd:integer
System.Int32	xsd:integer
System.Int64	xsd:integer
System.Single	xsd:float
System.String	xsd:string
System.IO.TextReader	xsd:string
System.IO.BinaryReader	xsd:base64Binary

** これらの型は CLS 準拠ではありません。対応する WriteValue メソッドがありません。

WriteValue を複数回連続して呼び出す場合、値をスペースで区切りません。スペースを挿入するには、複数回の WriteWhitespace 呼び出しの間に WriteValue を呼び出す必要があります。

WriteValue(Single)

単精度浮動小数点数を書き込みます。

public:
 virtual void WriteValue(float value);

public virtual void WriteValue (float value);

abstract member WriteValue : single -> unit
override this.WriteValue : single -> unit

Public Overridable Sub WriteValue (value As Single)

パラメーター

value: Single

書き込む単精度浮動小数点数。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

先行の非同期操作が完了する前に、XmlWriter メソッドが呼び出されました。この場合、「非同期操作が既に実行されています」というメッセージと共に InvalidOperationException がスローされます。

注釈

このメソッドは、XML スキーマ定義言語 (XSD) データ型変換規則を使用して、共通言語ランタイムオブジェクトを受け取り、入力値を目的の出力型に変換します。

WriteValue メソッドが呼び出されると、XmlWriter が、XML スキーマ (XSD) のデータ型変換規則に従って値をその文字列表現に変換し、WriteString メソッドを使用して書き出します。

WriteValue を複数回連続して呼び出す場合、値をスペースで区切りません。スペースを挿入するには、複数回の WriteWhitespace 呼び出しの間に WriteValue を呼び出す必要があります。配列型をオーバーロードに XmlWriter.WriteValue(Object) 渡して、個別の値の配列を書き出します。

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(Object)

オブジェクト値を書き込みます。

public:
 virtual void WriteValue(System::Object ^ value);

public virtual void WriteValue (object value);

abstract member WriteValue : obj -> unit
override this.WriteValue : obj -> unit

Public Overridable Sub WriteValue (value As Object)

パラメーター

value: Object

書き込むオブジェクト値。

メモ .NET Framework 3.5 のリリースでは、このメソッドは DateTimeOffset をパラメーターとして受け入れます。

例外

ArgumentException

無効な値が指定されました。

ArgumentNullException

value が null です。

InvalidOperationException

ライターが閉じているかエラー状態です。

または -

注釈

このメソッドは、共通言語ランタイム (CLR) オブジェクトを受け取り、XML スキーマ定義言語 (XSD) データ型変換規則を使用して、入力値を目的の出力型に変換します。

CLR オブジェクトがリスト型である場合は、ICollection値型IList IEnumerableの配列として扱われます。 XML XmlWriter スキーマ (XSD) データ型規則に従って値を文字列表現に変換し、メソッドを WriteString 使用して書き出します。

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(Int64)

Int64 値を書き込みます。

public:
 virtual void WriteValue(long value);

public virtual void WriteValue (long value);

abstract member WriteValue : int64 -> unit
override this.WriteValue : int64 -> unit

Public Overridable Sub WriteValue (value As Long)

パラメーター

value: Int64

書き込む Int64 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(Int32)

Int32 値を書き込みます。

public:
 virtual void WriteValue(int value);

public virtual void WriteValue (int value);

abstract member WriteValue : int -> unit
override this.WriteValue : int -> unit

Public Overridable Sub WriteValue (value As Integer)

パラメーター

value: Int32

書き込む Int32 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(Double)

Double 値を書き込みます。

public:
 virtual void WriteValue(double value);

public virtual void WriteValue (double value);

abstract member WriteValue : double -> unit
override this.WriteValue : double -> unit

Public Overridable Sub WriteValue (value As Double)

パラメーター

value: Double

書き込む Double 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

例

次の例では、型指定されたデータを使用してブックノードを書き込みます。

Double price = 9.95;
DateTime date = new DateTime(2004, 5, 20);

using (XmlWriter writer = XmlWriter.Create("data.xml"))
{
    writer.WriteStartElement("book");
    writer.WriteStartAttribute("pub-date");
    writer.WriteValue(date);
    writer.WriteEndAttribute();

    writer.WriteStartElement("price");
    writer.WriteValue(price);
    writer.WriteEndElement();

    writer.WriteEndElement();
    writer.Flush();
}

Dim price As [Double] = 9.95
Dim [date] As New DateTime(2004, 5, 20)
        
Using writer As XmlWriter = XmlWriter.Create("data.xml")
  writer.WriteStartElement("book")
  writer.WriteStartAttribute("pub-date")
  writer.WriteValue([date])
  writer.WriteEndAttribute()
            
  writer.WriteStartElement("price")
  writer.WriteValue(price)
  writer.WriteEndElement()
            
  writer.WriteEndElement()
  writer.Flush()
End Using

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(String)

String 値を書き込みます。

public:
 virtual void WriteValue(System::String ^ value);

public virtual void WriteValue (string value);

public virtual void WriteValue (string? value);

abstract member WriteValue : string -> unit
override this.WriteValue : string -> unit

Public Overridable Sub WriteValue (value As String)

パラメーター

value: String

書き込む String 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドを使用します WriteStringAsync 。

適用対象

WriteValue(DateTimeOffset)

DateTimeOffset 値を書き込みます。

public:
 virtual void WriteValue(DateTimeOffset value);

public virtual void WriteValue (DateTimeOffset value);

abstract member WriteValue : DateTimeOffset -> unit
override this.WriteValue : DateTimeOffset -> unit

Public Overridable Sub WriteValue (value As DateTimeOffset)

パラメーター

value: DateTimeOffset

書き込む DateTimeOffset 値。

例外

InvalidOperationException

注釈

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(DateTime)

DateTime 値を書き込みます。

public:
 virtual void WriteValue(DateTime value);

public virtual void WriteValue (DateTime value);

abstract member WriteValue : DateTime -> unit
override this.WriteValue : DateTime -> unit

Public Overridable Sub WriteValue (value As DateTime)

パラメーター

value: DateTime

書き込む DateTime 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

例

次の例では、型指定されたデータを使用してブックノードを書き込みます。

Double price = 9.95;
DateTime date = new DateTime(2004, 5, 20);

using (XmlWriter writer = XmlWriter.Create("data.xml"))
{
    writer.WriteStartElement("book");
    writer.WriteStartAttribute("pub-date");
    writer.WriteValue(date);
    writer.WriteEndAttribute();

    writer.WriteStartElement("price");
    writer.WriteValue(price);
    writer.WriteEndElement();

    writer.WriteEndElement();
    writer.Flush();
}

Dim price As [Double] = 9.95
Dim [date] As New DateTime(2004, 5, 20)
        
Using writer As XmlWriter = XmlWriter.Create("data.xml")
  writer.WriteStartElement("book")
  writer.WriteStartAttribute("pub-date")
  writer.WriteValue([date])
  writer.WriteEndAttribute()
            
  writer.WriteStartElement("price")
  writer.WriteValue(price)
  writer.WriteEndElement()
            
  writer.WriteEndElement()
  writer.Flush()
End Using

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(Boolean)

Boolean 値を書き込みます。

public:
 virtual void WriteValue(bool value);

public virtual void WriteValue (bool value);

abstract member WriteValue : bool -> unit
override this.WriteValue : bool -> unit

Public Overridable Sub WriteValue (value As Boolean)

パラメーター

value: Boolean

書き込む Boolean 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

WriteValue(Decimal)

Decimal 値を書き込みます。

public:
 virtual void WriteValue(System::Decimal value);

public virtual void WriteValue (decimal value);

abstract member WriteValue : decimal -> unit
override this.WriteValue : decimal -> unit

Public Overridable Sub WriteValue (value As Decimal)

パラメーター

value: Decimal

書き込む Decimal 値。

例外

ArgumentException

無効な値が指定されました。

InvalidOperationException

注釈

このメソッドがテキストのみを出力する XmlWriter インスタンスで呼び出された場合、型指定された値はテキストにシリアル化されます。

非同期操作の場合は、このメソッドの戻り値を文字列に変換し、メソッドを WriteStringAsync 使用します。

適用対象

XmlWriter.WriteValue メソッド

定義

オーバーロード

注釈

WriteValue(Single)

パラメーター

例外

注釈

適用対象

WriteValue(Object)

パラメーター

例外

注釈

適用対象

WriteValue(Int64)

パラメーター

例外

注釈

適用対象

WriteValue(Int32)

パラメーター

例外

注釈

適用対象

WriteValue(Double)

パラメーター

例外

例

注釈

適用対象

WriteValue(String)

パラメーター

例外

注釈

適用対象

WriteValue(DateTimeOffset)

パラメーター

例外

注釈

適用対象

WriteValue(DateTime)

パラメーター

例外

例

注釈

適用対象

WriteValue(Boolean)

パラメーター

例外

注釈

適用対象

WriteValue(Decimal)

パラメーター

例外

注釈

適用対象

その他のリソース