SessionStateItemCollection Class

Reference

Definition

Namespace:: System.Web.SessionState

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class SessionStateItemCollection sealed : System::Collections::Specialized::NameObjectCollectionBase, System::Collections::ICollection, System::Web::SessionState::ISessionStateItemCollection

public sealed class SessionStateItemCollection : System.Collections.Specialized.NameObjectCollectionBase, System.Collections.ICollection, System.Web.SessionState.ISessionStateItemCollection

type SessionStateItemCollection = class
    inherit NameObjectCollectionBase
    interface ISessionStateItemCollection
    interface ICollection
    interface IEnumerable

Public NotInheritable Class SessionStateItemCollection
Inherits NameObjectCollectionBase
Implements ICollection, ISessionStateItemCollection

Inheritance: Object

NameObjectCollectionBase
SessionStateItemCollection

Implements: ICollection IEnumerable ISessionStateItemCollection

Examples

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

SessionStateItemCollection items = new SessionStateItemCollection();

items["LastName"] = "Wilson";
items["FirstName"] = "Dan";

foreach (string s in items.Keys)
  Response.Write("items[\"" + s + "\"] = " + items[s].ToString() + "<br />");

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

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 Inheritors

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.

Constructors

SessionStateItemCollection()

Creates a new, empty SessionStateItemCollection object.

Properties

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.
IsReadOnly	Gets or sets a value indicating whether the NameObjectCollectionBase instance is read-only. (Inherited from NameObjectCollectionBase)
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.

Methods

BaseAdd(String, Object)	Adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseClear()	Removes all entries from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGet(Int32)	Gets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGet(String)	Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetAllKeys()	Returns a String array that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetAllValues()	Returns an Object array that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetAllValues(Type)	Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetKey(Int32)	Gets the key of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseHasKeys()	Gets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not `null`. (Inherited from NameObjectCollectionBase)
BaseRemove(String)	Removes the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseRemoveAt(Int32)	Removes the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseSet(Int32, Object)	Sets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseSet(String, Object)	Sets the value of the first entry with the specified key in the NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
Clear()	Removes all values and keys from the session-state collection.
Deserialize(BinaryReader)	Creates a SessionStateItemCollection collection from a storage location that is written to using the Serialize(BinaryWriter) 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.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. 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)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserialization(Object)	Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase)
Remove(String)	Deletes an item from the collection.
RemoveAt(Int32)	Deletes an item at a specified index from the collection.
Serialize(BinaryWriter)	Writes the contents of the collection to a BinaryWriter.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	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)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Share via