ObjectStateFormatter

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

ObjectStateFormatter クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

オブジェクトの状態を表すオブジェクト グラフをシリアル化および逆シリアル化します。このクラスは継承できません。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 ObjectStateFormatter
    Implements IStateFormatter, IFormatter

Visual Basic (使用法)

Dim instance As ObjectStateFormatter

C#

public sealed class ObjectStateFormatter :
 IStateFormatter, IFormatter

C++

public ref class ObjectStateFormatter sealed
 : IStateFormatter, IFormatter

J#

public final class ObjectStateFormatter implements
 IStateFormatter, IFormatter

JScript

public final class ObjectStateFormatter implements
 IStateFormatter, IFormatter

解説

ObjectStateFormatter クラスは、オブジェクトの状態グラフを圧縮形式でシリアル化したり逆シリアル化したりします。

ObjectStateFormatter は、ビューステートとコントロールの状態をシリアル化する目的で PageStatePersister クラスとその派生クラスによって使用されます。また、ASP.NET インフラストラクチャのさまざまな部分に対してオブジェクトの状態グラフ形式を提供する目的で LosFormatter クラスによっても使用されます。

ObjectStateFormatter クラスは、多くの共通 .NET Framework 参照型および定数をシリアル化し書式化するために最適化されます。最適化される型を次の表に示します。

Array	DateTime	Int16	String
ArrayList	Double	Int32	String []
Boolean	Enum	null (Nothing)	String.Empty
Byte	Hashtable	Pair	Triplet
Char	HybridDictionary	Single	Type
Color	IDictionary

また、従来の文字列型と文字列配列はそのままシリアル化されたバイナリ ライタに書き込まれたり、ライタから書き込まれたりしますが、内部の文字列テーブルを作成することにより、最適化される文字列もあります。文字列に関連付けられている TypeConverter オブジェクトがあったり、その文字列が実際には IndexedString クラスのインスタンスである場合に、これらのテーブルを使用して文字列が最適化されます。

前述の表に含まれていない型は、ISerializable インターフェイスを実装したり、SerializableAttribute 属性が付いている場合に、BinaryFormatter オブジェクトを使用してバイナリ シリアル化されます。ObjectStateFormatter クラスは、これらのシリアル化できる型に対しては最適化されません。

ObjectStateFormatter クラスがシリアル化できない型を検出した場合、ArgumentException 例外がスローされます。

使用例

PageStatePersister クラスの派生クラスから StateFormatter プロパティにアクセスして、ObjectStateFormatter インスタンスを取得し、ビューステートとコントロールの状態をシリアル化してストリームにする方法を次のコード例に示します。このコード例は、PageStatePersister クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

'
' Persist any ViewState and ControlState.
'
Public Overrides Sub Save()

    If Not (ViewState Is
 Nothing) OrElse Not (ControlState
 Is Nothing) Then
        If Not (Page.Session Is
 Nothing) Then

            Dim stateStream As Stream
            stateStream = GetSecureStream()

            ' Write a state string, using the StateFormatter.
            Dim writer As New
 StreamWriter(stateStream)

            Dim formatter As IStateFormatter
            formatter = Me.StateFormatter

            Dim statePair As New
 Pair(ViewState, ControlState)

            Dim serializedState As String
            serializedState = formatter.Serialize(statePair)

            writer.Write(serializedState)
            writer.Close()
            stateStream.Close()
        Else
            Throw New InvalidOperationException("Session
 needed for StreamPageStatePersister.")
        End If
    End If
End Sub 'Save

C#

//
// Persist any ViewState and ControlState.
//
public override void Save()
{

    if (ViewState != null || ControlState !=
 null)
    {
        if (Page.Session != null)
        {
            Stream stateStream = GetSecureStream();

            StreamWriter writer = new StreamWriter(stateStream);

            IStateFormatter formatter = this.StateFormatter;
            Pair statePair = new Pair(ViewState, ControlState);

            // Serialize the statePair object to a string.
            string serializedState = formatter.Serialize(statePair);

            writer.Write(serializedState);
            writer.Close();
            stateStream.Close();
        }
        else
            throw new InvalidOperationException("Session
 needed for StreamPageStatePersister.");
    }
}

継承階層

System.Object
  System.Web.UI.ObjectStateFormatter

スレッド セーフ

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

プラットフォーム

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

参照

関連項目
ObjectStateFormatter メンバ
System.Web.UI 名前空間

ObjectStateFormatter コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New ObjectStateFormatter

C#

public ObjectStateFormatter ()

C++

public:
ObjectStateFormatter ()

J#

public ObjectStateFormatter ()

JScript

public function ObjectStateFormatter ()

プラットフォーム

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

参照

関連項目
ObjectStateFormatter クラス
ObjectStateFormatter メンバ
System.Web.UI 名前空間

ObjectStateFormatter プロパティ

明示的インターフェイスの実装

	名前	説明
	System.Runtime.Serialization.IFormatter.Binder	このメンバの説明については、Formatter.Binder のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.Context	このメンバの説明については、IFormatter.Context のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.SurrogateSelector	このメンバの説明については、System.Runtime.Serialization.SurrogateSelector のトピックを参照してください。

参照

関連項目

ObjectStateFormatter クラス
System.Web.UI 名前空間

ObjectStateFormatter メソッド

パブリック メソッド

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

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

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Runtime.Serialization.IFormatter.Deserialize	このメンバの説明については、ObjectStateFormatter.Deserialize のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.Serialize	このメンバの説明については、ObjectStateFormatter.Serialize のトピックを参照してください。
	System.Web.UI.IStateFormatter.Deserialize	このメンバの説明については、ObjectStateFormatter.Deserialize のトピックを参照してください。
	System.Web.UI.IStateFormatter.Serialize	このメンバの説明については、ObjectStateFormatter.Serialize のトピックを参照してください。

参照

関連項目

ObjectStateFormatter クラス
System.Web.UI 名前空間

ObjectStateFormatter メンバ

オブジェクトの状態を表すオブジェクト グラフをシリアル化および逆シリアル化します。このクラスは継承できません。

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

パブリック コンストラクタ

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

パブリック メソッド

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

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

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.Runtime.Serialization.IFormatter.Deserialize	このメンバの説明については、ObjectStateFormatter.Deserialize のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.Serialize	このメンバの説明については、ObjectStateFormatter.Serialize のトピックを参照してください。
	System.Web.UI.IStateFormatter.Deserialize	このメンバの説明については、ObjectStateFormatter.Deserialize のトピックを参照してください。
	System.Web.UI.IStateFormatter.Serialize	このメンバの説明については、ObjectStateFormatter.Serialize のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.Binder	このメンバの説明については、Formatter.Binder のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.Context	このメンバの説明については、IFormatter.Context のトピックを参照してください。
	System.Runtime.Serialization.IFormatter.SurrogateSelector	このメンバの説明については、System.Runtime.Serialization.SurrogateSelector のトピックを参照してください。

参照

関連項目

ObjectStateFormatter クラス
System.Web.UI 名前空間