StateManagedCollection.SetDirtyObject メソッド

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

StateManagedCollection.SetDirtyObject メソッド

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

派生クラスでオーバーライドされた場合、コレクションに格納されている object に、変更情報だけでなく、その状態全体をビューステートに記録するよう指示します。

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

Visual Basic (宣言)

Protected MustOverride Sub
 SetDirtyObject ( _
    o As Object _
)

Visual Basic (使用法)

Dim o As Object

Me.SetDirtyObject(o)

C#

protected abstract void SetDirtyObject (
    Object o
)

C++

protected:
virtual void SetDirtyObject (
    Object^ o
) abstract

J#

protected abstract void SetDirtyObject (
    Object o
)

JScript

protected abstract function SetDirtyObject
 (
    o : Object
)

パラメータ

o

自身を完全にシリアル化する必要のある IStateManager。

解説

SetDirtyObject メソッドは、System.Web.UI.IStateManager.SaveViewState、System.Collections.IList.Add、および System.Collections.IList.Insert の各メソッドによって内部的に呼び出されます。

使用例

厳密に型指定された StateManagedCollection クラスが、抽象 SetDirtyObject メソッドを実装する方法を次のコード例に示します。CycleCollection はそのビューステート情報を格納するために StateBag オブジェクトを使用し、StateBag オブジェクトの SetDirty メソッドの呼び出しを代行します。このコード例は、StateManagedCollection クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

'////////////////////////////////////////////////////////////
'
' The strongly typed CycleCollection class is a collection
' that contains Cycle class instances, which implement the
' IStateManager interface.
'
'////////////////////////////////////////////////////////////
<AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
               Public NotInheritable Class
 CycleCollection
    Inherits StateManagedCollection

    Private Shared _typesOfCycles() As
 Type = _
        {GetType(Bicycle), GetType(Tricycle)}

    Protected Overrides Function
 CreateKnownType(ByVal index As Integer)
 As Object
        Select Case index
            Case 0
                Return New Bicycle()
            Case 1
                Return New Tricycle()
            Case Else
                Throw New ArgumentOutOfRangeException("Unknown
 Type")
        End Select

    End Function


    Protected Overrides Function
 GetKnownTypes() As Type()
        Return _typesOfCycles

    End Function


    Protected Overrides Sub
 SetDirtyObject(ByVal o As Object)
        CType(o, Cycle).SetDirty()

    End Sub
End Class

C#

//////////////////////////////////////////////////////////////
//
// The strongly typed CycleCollection class is a collection
// that contains Cycle class instances, which implement the
// IStateManager interface.
//
//////////////////////////////////////////////////////////////
[AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
public sealed class CycleCollection : StateManagedCollection
 {
    
    private static readonly Type[] _typesOfCycles
 
        = new Type[] { typeof(Bicycle), typeof(Tricycle) };

    protected override object CreateKnownType(int
 index) {
        switch(index) {
            case 0:
                return new Bicycle();
            case 1:
                return new Tricycle();    
                
            default:
                throw new ArgumentOutOfRangeException("Unknown
 Type");
        }            
    }

    protected override Type[] GetKnownTypes() {
        return _typesOfCycles;
    }

    protected override void SetDirtyObject(object
 o) {
        ((Cycle)o).SetDirty();
    }

}

プラットフォーム

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

参照

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