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
protected abstract void SetDirtyObject (
	Object o
protected abstract function SetDirtyObject (
	o : Object
Not applicable.



The IStateManager that should serialize itself completely.

The SetDirtyObject method is called internally by the System.Web.UI.IStateManager.SaveViewState, System.Collections.IList.Add, and System.Collections.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.
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) {


Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

© 2014 Microsoft