ISessionStateItemCollection.Dirty Property

Definition

Gets or sets a value indicating whether the collection has been marked as changed.

C#
public bool Dirty { get; set; }

Property Value

true if the SessionStateItemCollection contents have been changed; otherwise, false.

Examples

The following code example shows an implementation of the Dirty property. For an example of a complete implementation of the ISessionStateItemCollection interface, see the example provided for the ISessionStateItemCollection interface overview.

C#
private bool pDirty = false;

public bool Dirty
{
  get { return pDirty; }
  set { pDirty = value; }
}

Remarks

The Dirty property is used by the SessionStateModule to determine whether the values in an ISessionStateItemCollection implementation have been modified.

In implementing the ISessionStateItemCollection interface, you should initialize the Dirty property as false and set the Dirty property to true in the implementations of the Remove, RemoveAt, or Clear methods.

Applies to

Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

See also