Export (0) Print
Expand All

StateManagedCollection.SetDirtyObject Method

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


Type: System.Object

The IStateManager that should serialize itself completely.

The SetDirtyObject method is called internally by the SaveViewState, Add, and 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. 
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();                    
                throw new ArgumentOutOfRangeException("Unknown Type");

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

    protected override void SetDirtyObject(object o) {


.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft