This topic has not yet been rated - Rate this topic

SessionStateItemCollection Class

.NET Framework 4.5

A collection of objects stored in session state. This class cannot be inherited.

System.Object
System.Collections.Specialized.NameObjectCollectionBase
System.Web.SessionState.SessionStateItemCollection

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

Syntax

C++

'Declaration
Public NotInheritable Class SessionStateItemCollection _
	Inherits NameObjectCollectionBase _
	Implements ISessionStateItemCollection, ICollection, IEnumerable

The SessionStateItemCollection type exposes the following members.

Constructors

	Name	Description
	SessionStateItemCollection	Creates a new, empty SessionStateItemCollection object.

Top

Properties

	Name	Description
	Count	Gets the number of key/value pairs contained in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
	Dirty	Gets or sets a value indicating whether the collection has been marked as changed.
	Item(Int32)	Gets or sets a value in the collection by numerical index.
	Item(String)	Gets or sets a value in the collection by name.
	Keys	Gets a collection of the variable names for all values stored in the collection. (Overrides NameObjectCollectionBase.Keys.)

Top

Methods

	Name	Description
	Clear	Removes all values and keys from the session-state collection.
	Deserialize	Creates a SessionStateItemCollection collection from a storage location that is written to using the Serialize method.
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that can be used to read all the key names in the collection. (Overrides NameObjectCollectionBase.GetEnumerator.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjectData	Implements the ISerializable interface and returns the data needed to serialize the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	OnDeserialization	Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase.)
	Remove	Deletes an item from the collection.
	RemoveAt	Deletes an item at a specified index from the collection.
	Serialize	Writes the contents of the collection to a BinaryWriter.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	AsParallel	Enables parallelization of a query. (Defined by ParallelEnumerable.)
	AsQueryable	Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
	Cast(Of TResult)	Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
	OfType(Of TResult)	Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)

Top

Explicit Interface Implementations

	Name	Description
	ICollection.CopyTo	Copies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameObjectCollectionBase.)
	ICollection.IsSynchronized	Gets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe). (Inherited from NameObjectCollectionBase.)
	ICollection.SyncRoot	Gets an object that can be used to synchronize access to the NameObjectCollectionBase object. (Inherited from NameObjectCollectionBase.)

Top

Remarks

The SessionStateItemCollection class is used to manage session-state variable values indexed by a variable name or by numerical index. The session-state variables are exposed to ASP.NET application code using the HttpSessionState class, which is accessed using the Session property of the current HttpContext or the Page. The HttpSessionState class calls the HttpSessionStateContainer class, which manages session-state variable values using the SessionStateItemCollection.

Notes to Implementers

When you create a custom session-state provider based on the SessionStateStoreProviderBase class, use the SessionStateItemCollection class to manage the items stored in session state. If you need to create a custom object to manage session-state items, implement the ISessionStateItemCollection interface.

Examples

The following code example creates a new SessionStateItemCollection object and sets and gets values in the collection by name.

Dim items As SessionStateItemCollection = New SessionStateItemCollection()

items("LastName") = "Wilson"
items("FirstName") = "Dan"

For Each s As String In items.Keys
  Response.Write("items(""" & s & """) = " & items(s).ToString() & "<br />")
Next

Version Information

.NET Framework

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

Platforms

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Web.SessionState Namespace

Other Resources

ASP.NET Session State Overview

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)