แก้ไข

แชร์ผ่าน

StateManagedCollection.SetDirtyObject(Object) Method

  • Reference

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.dll

When overridden in a derived class, instructs an object contained by the collection to record its entire state to view state, rather than recording only change information.

protected:
 abstract void SetDirtyObject(System::Object ^ o);
protected abstract void SetDirtyObject (object o);
abstract member SetDirtyObject : obj -> unit
Protected MustOverride Sub SetDirtyObject (o As Object)

Parameters

o
Object

The IStateManager that should serialize itself completely.

Examples

The following code example demonstrates how a strongly typed StateManagedCollection class implements the abstract SetDirtyObject method. The CycleCollection uses a StateBag object to store its view-state information, and simply delegates the call to the SetDirty method of the StateBag object. This code example is part of a larger example provided for the StateManagedCollection class.

//////////////////////////////////////////////////////////////
//
// 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();
    }
}

'////////////////////////////////////////////////////////////
'
' 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

Remarks

The SetDirtyObject method is called internally by the IStateManager.SaveViewState, IList.Add, and IList.Insert methods.

Applies to

See also