ISessionStateItemCollection インターフェイス

定義

ASP.NET セッション状態がセッションを管理するために使用するコレクションのコントラクトを定義します。Defines the contract for the collection used by ASP.NET session state to manage session.

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
派生
実装

次のコード例ではISessionStateItemCollection 、を実装SortedListし、クラスを使用してセッション状態の変数名と値を格納します。The following code example implements the ISessionStateItemCollection and uses the SortedList class to store session-state variable names and values.

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クラスによってアプリケーションコードに公開されるセッション項目のコレクションを定義します。The ISessionStateItemCollection interface defines the collection of session items exposed to application code by the HttpSessionStateContainer class.

ISessionStateItemCollection インターフェイスSessionStateItemCollectionの ASP.NET 実装はクラスです。The ASP.NET implementation of the ISessionStateItemCollection interface is the SessionStateItemCollection class.

クラスから派生したクラスを作成SessionStateStoreProviderBaseしてセッションデータを格納する場合は、 SessionStateItemCollectionクラスを使用してISessionStateItemCollection格納されたオブジェクトを管理するか、独自のコレクションマネージャーでインターフェイスを実装することができます。If you create a class derived from the SessionStateStoreProviderBase class to store session data, you can either use the SessionStateItemCollection class to manage the stored objects or implement the ISessionStateItemCollection interface on your own collection manager.

ISessionStateItemCollectionインターフェイスを実装する場合は、実装を使用してISessionStateItemCollectionセッション変数をSessionStateStoreProviderBase管理するために、クラスを継承するクラスも作成する必要があります。If you implement the ISessionStateItemCollection interface, you must also create a class that inherits the SessionStateStoreProviderBase class in order to make use of your ISessionStateItemCollection implementation to manage session variables.

実装ISessionStateItemCollectionでは、 ICollectionインターフェイスのメンバーも実装する必要があります。An ISessionStateItemCollection implementation must also implement the members of the ICollection interface.

プロパティ

Count

ICollection に格納されている要素の数を取得します。Gets the number of elements contained in the ICollection.

(継承元 ICollection)
Dirty

コレクションが変更されたかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the collection has been marked as changed.

IsSynchronized

ICollection へのアクセスが同期されている (スレッド セーフである) かどうかを示す値を取得します。Gets a value indicating whether access to the ICollection is synchronized (thread safe).

(継承元 ICollection)
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.

SyncRoot

ICollection へのアクセスを同期するために使用できるオブジェクトを取得します。Gets an object that can be used to synchronize access to the ICollection.

(継承元 ICollection)

メソッド

Clear()

セッション状態のコレクションからすべての値とキーを削除します。Removes all values and keys from the session-state collection.

CopyTo(Array, Int32)

ICollection の要素を Array にコピーします。Array の特定のインデックスからコピーが開始されます。Copies the elements of the ICollection to an Array, starting at a particular Array index.

(継承元 ICollection)
GetEnumerator()

コレクションを反復処理する列挙子を返します。Returns an enumerator that iterates through a collection.

(継承元 IEnumerable)
Remove(String)

コレクションから項目を削除します。Deletes an item from the collection.

RemoveAt(Int32)

コレクション内の指定したインデックス位置の項目を削除します。Deletes an item at a specified index from the collection.

拡張メソッド

Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

クエリの並列化を有効にします。Enables parallelization of a query.

AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

適用対象

こちらもご覧ください