ISessionStateItemCollection インターフェイス

リファレンス

定義

名前空間:: System.Web.SessionState

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ASP.NET セッション状態がセッションを管理するために使用するコレクションのコントラクトを定義します。

public interface class ISessionStateItemCollection : System::Collections::ICollection

public interface ISessionStateItemCollection : System.Collections.ICollection

type ISessionStateItemCollection = interface
    interface ICollection
    interface IEnumerable

Public Interface ISessionStateItemCollection
Implements ICollection

派生: System.Web.SessionState.SessionStateItemCollection

実装: ICollection IEnumerable

例

次のコード例では、 ISessionStateItemCollection を実装し、クラスを SortedList 使用してセッション状態の変数名と値を格納します。

using System;
using System.Web;
using System.Web.SessionState;
using System.Collections;
using System.Collections.Specialized;

namespace Samples.AspNet.Session
{

  public class MySessionStateItemCollection : ISessionStateItemCollection
  {
    private SortedList pItems = new SortedList();
    private bool pDirty = false;

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

    public object this[int index]
    {
      get { return pItems[index]; }
      set
      {
        pItems[index] = value;
        pDirty = true;
      }
    }

    public object this[string name]
    {
      get { return pItems[name]; }
      set
      {
        pItems[name] = value;
        pDirty = true;
      }
    }

    public NameObjectCollectionBase.KeysCollection Keys
    {
      get { return (NameObjectCollectionBase.KeysCollection)pItems.Keys; }
    }

    public int Count
    {
      get { return pItems.Count; }
    }

    public Object SyncRoot
    {
      get { return this; }
    }

    public bool IsSynchronized
    {
      get { return false; }
    }

    public IEnumerator GetEnumerator()
    {
      return pItems.GetEnumerator(); 
    }

    public void Clear()
    {
      pItems.Clear();
      pDirty = true;
    }

    public void Remove(string name)
    {
      pItems.Remove(name);
      pDirty = true;
    }

    public void RemoveAt(int index)
    {
      if (index < 0 || index >= this.Count)
        throw new ArgumentOutOfRangeException("The specified index is not within the acceptable range.");

      pItems.RemoveAt(index);
      pDirty = true;
    }

    public void CopyTo(Array array, int index)
    {
      pItems.CopyTo(array, index);
    }
  }
}

Imports System.Web
Imports System.Web.SessionState
Imports System.Collections
Imports System.Collections.Specialized


Namespace Samples.AspNet.Session

  Public Class MySessionStateItemCollection
    Implements ISessionStateItemCollection
  
    Private pItems As SortedList = New SortedList()
    Private pDirty As Boolean = False

    Public Property Dirty As Boolean Implements ISessionStateItemCollection.Dirty    
      Get
        Return pDirty
      End Get
      Set
        pDirty = value
      End Set
    End Property

    Public Property Item(index As Integer) As Object Implements ISessionStateItemCollection.Item
      Get
        Return pItems(index)
      End Get
      Set
        pItems(index) = value
        pDirty = True
      End Set
    End Property

    Public Property Item(name As String) As Object Implements ISessionStateItemCollection.Item
      Get
        Return pItems(name)
      End Get
      Set
        pItems(name) = value
        pDirty = True
      End Set
    End Property

    Public ReadOnly Property Keys As NameObjectCollectionBase.KeysCollection _
      Implements ISessionStateItemCollection.Keys
      Get
        Return CType(pItems.Keys, NameObjectCollectionBase.KeysCollection)
      End Get
    End Property

    Public ReadOnly Property Count As Integer Implements ICollection.Count    
      Get
        Return pItems.Count
      End Get
    End Property

    Public ReadOnly Property SyncRoot As Object Implements ICollection.SyncRoot    
      Get
        Return Me
      End Get
    End Property

    Public ReadOnly Property IsSynchronized As Boolean Implements ICollection.IsSynchronized
      Get
        Return False
      End Get
    End Property

    Public Function GetEnumerator() As IEnumerator Implements ICollection.GetEnumerator    
      Return pItems.GetEnumerator() 
    End Function

    Public Sub Clear() Implements ISessionStateItemCollection.Clear
      pItems.Clear()
      pDirty = True
    End Sub

    Public Sub Remove(name As String) Implements ISessionStateItemCollection.Remove
      pItems.Remove(name)
      pDirty = True
    End Sub

    Public Sub RemoveAt(index As Integer) Implements ISessionStateItemCollection.RemoveAt 
      If index < 0 OrElse index >= Me.Count Then _
        Throw New ArgumentOutOfRangeException("The specified index is not within the acceptable range.")
   
      pItems.RemoveAt(index)
      pDirty = True
    End Sub

    Public Sub CopyTo(array As Array, index As Integer) Implements ICollection.CopyTo
      pItems.CopyTo(array, index)
    End Sub

  End Class

End Namespace

注釈

インターフェイスは ISessionStateItemCollection 、クラスによってアプリケーションコードに公開されるセッション項目のコレクションを HttpSessionStateContainer 定義します。

インターフェイスの ASP.NET 実装 ISessionStateItemCollection はクラス SessionStateItemCollection です。

セッションデータを格納するためにクラスから SessionStateStoreProviderBase 派生したクラスを作成する場合は、クラスを SessionStateItemCollection 使用して格納されているオブジェクトを管理するか、独自のコレクションマネージャーにインターフェイスを実装 ISessionStateItemCollection できます。

インターフェイスを実装する場合は、実装をISessionStateItemCollection使用ISessionStateItemCollectionしてセッション変数を管理するために、クラスを継承SessionStateStoreProviderBaseするクラスも作成する必要があります。

実装では ISessionStateItemCollection 、インターフェイスのメンバーも実装する ICollection 必要があります。

プロパティ

Count	ICollection に格納されている要素の数を取得します。 (継承元 ICollection)
Dirty	コレクションが変更されたかどうかを示す値を取得または設定します。
IsSynchronized	ICollection へのアクセスが同期されている (スレッドセーフである) かどうかを示す値を取得します。 (継承元 ICollection)
Item[Int32]	コレクション内の値を数値インデックスで取得または設定します。
Item[String]	コレクション内の値を名前で取得または設定します。
Keys	コレクションに保存されているすべての値の変数名の一覧を取得します。
SyncRoot	ICollection へのアクセスを同期するために使用できるオブジェクトを取得します。 (継承元 ICollection)

メソッド

Clear()	セッション状態のコレクションからすべての値とキーを削除します。
CopyTo(Array, Int32)	ICollection の要素を Array にコピーします。Array の特定のインデックスからコピーが開始されます。 (継承元 ICollection)
GetEnumerator()	コレクションを反復処理する列挙子を返します。 (継承元 IEnumerable)
Remove(String)	コレクションから項目を削除します。
RemoveAt(Int32)	コレクション内の指定したインデックス位置の項目を削除します。

拡張メソッド

Cast<TResult>(IEnumerable)	IEnumerable の要素を、指定した型にキャストします。
OfType<TResult>(IEnumerable)	指定された型に基づいて IEnumerable の要素をフィルター処理します。
AsParallel(IEnumerable)	クエリの並列化を有効にします。
AsQueryable(IEnumerable)	IEnumerable を IQueryable に変換します。

適用対象

こちらもご覧ください

ASP.NET セッション状態の概要