StateBag.IsItemDirty(String) Method

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

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

C#

public bool IsItemDirty(string key);

Parameters

key

String

The key of the item to check.

Returns

Boolean

true if the item has been modified; otherwise, false.

Examples

The following code example demonstrates using the IsItemDirty method.

C#

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

Remarks

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

Applies to

See also

• ViewState