Formatter

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

Formatter クラス

共通言語ランタイムのシリアル化フォーマッタの基本機能を提供します。

このクラスは、CLS に準拠していません。  

名前空間: System.Runtime.Serialization
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<SerializableAttribute> _
<ComVisibleAttribute(True)> _
<CLSCompliantAttribute(False)> _
Public MustInherit Class
 Formatter
    Implements IFormatter

Visual Basic (使用法)

Dim instance As Formatter

C#

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[CLSCompliantAttribute(false)] 
public abstract class Formatter : IFormatter

C++

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[CLSCompliantAttribute(false)] 
public ref class Formatter abstract : IFormatter

J#

/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
/** @attribute CLSCompliantAttribute(false) */ 
public abstract class Formatter implements
 IFormatter

JScript

SerializableAttribute 
ComVisibleAttribute(true) 
CLSCompliantAttribute(false) 
public abstract class Formatter implements
 IFormatter

解説

Formatter は、すべてのランタイム シリアル化フォーマッタの abstract 基本クラスであり、IFormatter インターフェイスを実装するためのヘルパー メソッドを提供します。また、Formatter は、シリアル化のためのオブジェクトのキュー、およびオブジェクト単位での ID の生成を管理します。

継承時の注意

• Formatter から継承する場合は、Serialize のメンバをオーバーライドする必要があります。

• Deserialize

• WriteArray

• WriteBoolean

• WriteByte

• WriteChar

• WriteDateTime

• WriteDecimal

• WriteDouble

• WriteInt16

• WriteInt32

• WriteInt64

• WriteObjectRef

• WriteSByte

• WriteSingle

• WriteTimeSpan

• WriteUInt16

• WriteUInt32

• WriteUInt64

• WriteValueType

• SurrogateSelector

• Binder

• Context

継承階層

System.Object
  System.Runtime.Serialization.Formatter

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
Formatter メンバ
System.Runtime.Serialization 名前空間
ObjectIDGenerator
その他の技術情報
XML シリアル化および SOAP シリアル化

Formatter コンストラクタ

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

このコンストラクタは、CLS に準拠していません。  

名前空間: System.Runtime.Serialization
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Protected Sub New

Visual Basic (使用法)

Dim instance As New Formatter

C#

protected Formatter ()

C++

protected:
Formatter ()

J#

protected Formatter ()

JScript

protected function Formatter ()

解説

シリアル化対象のオブジェクトの Queue、およびこれらのオブジェクトの ID を生成する ObjectIDGenerator を作成します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
Formatter クラス
Formatter メンバ
System.Runtime.Serialization 名前空間
ObjectIDGenerator

Formatter フィールド

プロテクト フィールド

	名前	説明
	m_idGenerator	現在のフォーマッタと共に使用する ObjectIDGenerator を格納します。
	m_objectQueue	残されたシリアル化対象のオブジェクトの Queue を格納します。

参照

関連項目

Formatter クラス
System.Runtime.Serialization 名前空間
ObjectIDGenerator

その他の技術情報

XML シリアル化および SOAP シリアル化

Formatter プロパティ

パブリック プロパティ

	名前	説明
	Binder	派生クラスでオーバーライドされると、現在のフォーマッタと共に使用する SerializationBinder を取得または設定します。
	Context	派生クラスでオーバーライドされると、現在のシリアル化に使用する StreamingContext を取得または設定します。
	SurrogateSelector	派生クラスでオーバーライドされると、現在のフォーマッタと共に使用する ISurrogateSelector を取得または設定します。

参照

関連項目

Formatter クラス
System.Runtime.Serialization 名前空間
ObjectIDGenerator

その他の技術情報

XML シリアル化および SOAP シリアル化

Formatter メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Deserialize	派生クラスでオーバーライドされると、作成時にフォーマッタに結び付けられているストリームを逆シリアル化して、そのストリームに初めにシリアル化されたグラフと同一のオブジェクトのグラフを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Serialize	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに、指定したルートのオブジェクトのグラフをシリアル化します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	GetNext	フォーマッタの内部の作業キューから、次のシリアル化対象のオブジェクトを返します。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	Schedule	後でシリアル化するために、オブジェクトをスケジュールします。
	WriteArray	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに配列を書き込みます。
	WriteBoolean	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに Boolean 値を書き込みます。
	WriteByte	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 8 ビット符号なし整数を書き込みます。
	WriteChar	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに Unicode 文字を書き込みます。
	WriteDateTime	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに DateTime 値を書き込みます。
	WriteDecimal	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに Decimal 値を書き込みます。
	WriteDouble	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに倍精度浮動小数点数を書き込みます。
	WriteInt16	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 16 ビット符号付き整数を書き込みます。
	WriteInt32	派生クラスでオーバーライドされると、ストリームに 32 ビット符号付き整数を書き込みます。
	WriteInt64	派生クラスでオーバーライドされると、ストリームに 64 ビット符号付き整数を書き込みます。
	WriteMember	受信したデータの型を検査し、適切な Write メソッドを呼び出して、既にフォーマッタに結び付けられているストリームへの書き込みを実行します。
	WriteObjectRef	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームにオブジェクト参照を書き込みます。
	WriteSByte	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 8 ビット符号付き整数を書き込みます。
	WriteSingle	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに単精度浮動小数点数を書き込みます。
	WriteTimeSpan	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに TimeSpan 値を書き込みます。
	WriteUInt16	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 16 ビット符号なし整数を書き込みます。
	WriteUInt32	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 32 ビット符号なし整数を書き込みます。
	WriteUInt64	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 64 ビット符号なし整数を書き込みます。
	WriteValueType	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに、指定された型の値を書き込みます。

参照

関連項目

Formatter クラス
System.Runtime.Serialization 名前空間
ObjectIDGenerator

その他の技術情報

XML シリアル化および SOAP シリアル化

Formatter メンバ

共通言語ランタイムのシリアル化フォーマッタの基本機能を提供します。

Formatter データ型で公開されるメンバを以下の表に示します。

プロテクト コンストラクタ

	名前	説明
	Formatter	Formatter クラスの新しいインスタンスを初期化します。

プロテクト フィールド

	名前	説明
	m_idGenerator	現在のフォーマッタと共に使用する ObjectIDGenerator を格納します。
	m_objectQueue	残されたシリアル化対象のオブジェクトの Queue を格納します。

パブリック プロパティ

	名前	説明
	Binder	派生クラスでオーバーライドされると、現在のフォーマッタと共に使用する SerializationBinder を取得または設定します。
	Context	派生クラスでオーバーライドされると、現在のシリアル化に使用する StreamingContext を取得または設定します。
	SurrogateSelector	派生クラスでオーバーライドされると、現在のフォーマッタと共に使用する ISurrogateSelector を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Deserialize	派生クラスでオーバーライドされると、作成時にフォーマッタに結び付けられているストリームを逆シリアル化して、そのストリームに初めにシリアル化されたグラフと同一のオブジェクトのグラフを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Serialize	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに、指定したルートのオブジェクトのグラフをシリアル化します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetNext	フォーマッタの内部の作業キューから、次のシリアル化対象のオブジェクトを返します。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	Schedule	後でシリアル化するために、オブジェクトをスケジュールします。
	WriteArray	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに配列を書き込みます。
	WriteBoolean	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに Boolean 値を書き込みます。
	WriteByte	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 8 ビット符号なし整数を書き込みます。
	WriteChar	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに Unicode 文字を書き込みます。
	WriteDateTime	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに DateTime 値を書き込みます。
	WriteDecimal	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに Decimal 値を書き込みます。
	WriteDouble	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに倍精度浮動小数点数を書き込みます。
	WriteInt16	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 16 ビット符号付き整数を書き込みます。
	WriteInt32	派生クラスでオーバーライドされると、ストリームに 32 ビット符号付き整数を書き込みます。
	WriteInt64	派生クラスでオーバーライドされると、ストリームに 64 ビット符号付き整数を書き込みます。
	WriteMember	受信したデータの型を検査し、適切な Write メソッドを呼び出して、既にフォーマッタに結び付けられているストリームへの書き込みを実行します。
	WriteObjectRef	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームにオブジェクト参照を書き込みます。
	WriteSByte	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 8 ビット符号付き整数を書き込みます。
	WriteSingle	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに単精度浮動小数点数を書き込みます。
	WriteTimeSpan	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに TimeSpan 値を書き込みます。
	WriteUInt16	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 16 ビット符号なし整数を書き込みます。
	WriteUInt32	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 32 ビット符号なし整数を書き込みます。
	WriteUInt64	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに 64 ビット符号なし整数を書き込みます。
	WriteValueType	派生クラスでオーバーライドされると、フォーマッタに既に結び付けられているストリームに、指定された型の値を書き込みます。

参照

関連項目

Formatter クラス
System.Runtime.Serialization 名前空間
ObjectIDGenerator

その他の技術情報

XML シリアル化および SOAP シリアル化