Export (0) Print
Expand All

StateBag.IsItemDirty Method

Checks a StateItem object stored in the StateBag object to evaluate whether it has been modified since the call to Control.TrackViewState.

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

public bool IsItemDirty(
	string key
)

Parameters

key
Type: System.String
The key of the item to check.

Return Value

Type: System.Boolean
true if the item has been modified; otherwise, false.

This method also returns false if the key parameter does not exist in the StateBag object.

The following code example demonstrates using the IsItemDirty method.


        // Implement the SaveViewState method. If the StateBag
        // that stores the MyItem class's view state contains
        // a value for the message property and if the value
        // has changed since the TrackViewState method was last 
        // called, all view state for this class is deleted, 
        // using the StateBag.Clear method,and the new value is added.
        object IStateManager.SaveViewState()
        {
            // Check whether the message property exists in 
            // the ViewState property, and if it does, check
            // whether it has changed since the most recent
            // TrackViewState method call.
            if (!((IDictionary)_viewstate).Contains("message") || _viewstate.IsItemDirty("message"))
            {
                _viewstate.Clear();
                // Add the _message property to the StateBag.
                _viewstate.Add("message", _message);
            }
            return ((IStateManager)_viewstate).SaveViewState();
        }



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft