StateManagedCollection.SetDirtyObject Method (Object)

 

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.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

protected abstract void SetDirtyObject(
	object o
)

Parameters

o
Type: System.Object

The IStateManager that should serialize itself completely.

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

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

}

.NET Framework
Available since 2.0
Return to top
Show: