StateManagedCollection クラス

定義

IStateManager オブジェクトを管理する厳密に型指定されたすべてのコレクションの基本クラスを提供します。Provides a base class for all strongly typed collections that manage IStateManager objects.

public ref class StateManagedCollection abstract : System::Collections::IList, System::Web::UI::IStateManager
public abstract class StateManagedCollection : System.Collections.IList, System.Web.UI.IStateManager
type StateManagedCollection = class
    interface IList
    interface ICollection
    interface IEnumerable
    interface IStateManager
Public MustInherit Class StateManagedCollection
Implements IList, IStateManager
継承
StateManagedCollection
派生
実装

次のコード例は、厳密に型指定されたコレクションクラスを StateManagedCollection から派生させ、IStateManager オブジェクトを格納する方法を示しています。The following code example demonstrates how to derive a strongly typed collection class from StateManagedCollection to contain IStateManager objects. この例では、CycleCollection は抽象 Cycle クラスのインスタンスを含むように派生しています。これには Bicycle または Tricycle オブジェクトを含めることができます。In this example, the CycleCollection is derived to contain instances of the abstract Cycle class, which can be either Bicycle or Tricycle objects. Cycle クラスは、CycleColor プロパティの値をビューステートに格納するため、IStateManager インターフェイスを実装します。The Cycle class implements the IStateManager interface because it stores the value of the CycleColor property in view state.

namespace Samples.AspNet.CS.Controls {

    using System;
    using System.Security.Permissions;
    using System.Collections;
    using System.ComponentModel;
    using System.Drawing;           
    using System.Web;
    using System.Web.UI;            
    //////////////////////////////////////////////////////////////
    //
    // The strongly typed CycleCollection class is a collection
    // that contains Cycle class instances, which implement the
    // IStateManager interface.
    //
    //////////////////////////////////////////////////////////////
    [AspNetHostingPermission(SecurityAction.Demand, 
        Level=AspNetHostingPermissionLevel.Minimal)]
    public sealed class CycleCollection : StateManagedCollection {
        
        private static readonly Type[] _typesOfCycles 
            = new Type[] { typeof(Bicycle), typeof(Tricycle) };

        protected override object CreateKnownType(int index) {
            switch(index) {
                case 0:
                    return new Bicycle();
                case 1:
                    return new Tricycle();                    
                default:
                    throw new ArgumentOutOfRangeException("Unknown Type");
            }            
        }

        protected override Type[] GetKnownTypes() {
            return _typesOfCycles;
        }

        protected override void SetDirtyObject(object o) {
            ((Cycle)o).SetDirty();
        }

    }
    //////////////////////////////////////////////////////////////
    //
    // The abstract Cycle class represents bicycles and tricycles.
    //
    //////////////////////////////////////////////////////////////
    public abstract class Cycle : IStateManager {

        protected internal Cycle(int numWheels) : this(numWheels, "Red"){ }
        
        protected internal Cycle(int numWheels, String color) {    
            numberOfWheels = numWheels;
            CycleColor = color;
        }
        
        private int numberOfWheels = 0;
        public int NumberOfWheels {
            get { return numberOfWheels; }
        }
        
        public string CycleColor {
            get { 
                object o = ViewState["Color"];
                return (null == o) ? String.Empty : o.ToString() ;
            }
            set {
                ViewState["Color"] = value;            
            }        
        }

        internal void SetDirty() {
            ViewState.SetDirty(true);
        }
        
        // Because Cycle does not derive from Control, it does not 
        // have access to an inherited view state StateBag object.
        private StateBag viewState;
        private StateBag ViewState {
            get {
                if (viewState == null) {
                    viewState = new StateBag(false);
                    if (isTrackingViewState) {
                        ((IStateManager)viewState).TrackViewState();
                    }
                }
                return viewState;
            }
        }

        // The IStateManager implementation.
        private bool isTrackingViewState;
        bool IStateManager.IsTrackingViewState {
            get {
                return isTrackingViewState;
            }
        }

        void IStateManager.LoadViewState(object savedState) {
            object[] cycleState = (object[]) savedState;
            
            // In SaveViewState, an array of one element is created.
            // Therefore, if the array passed to LoadViewState has 
            // more than one element, it is invalid.
            if (cycleState.Length != 1) {
                throw new ArgumentException("Invalid Cycle View State");
            }
            
            // Call LoadViewState on the StateBag object.
            ((IStateManager)ViewState).LoadViewState(cycleState[0]);
        }

        // Save the view state by calling the StateBag's SaveViewState
        // method.
        object IStateManager.SaveViewState() {
            object[] cycleState = new object[1];

            if (viewState != null) {
                cycleState[0] = ((IStateManager)viewState).SaveViewState();
            }
            return cycleState;
        }

        // Begin tracking view state. Check the private variable, because 
        // if the view state has not been accessed or set, then it is not  
        // being used and there is no reason to store any view state.
        void IStateManager.TrackViewState() {
            isTrackingViewState = true;
            if (viewState != null) {
                ((IStateManager)viewState).TrackViewState();
            }
        }        
    }

    public sealed class Bicycle : Cycle {
    
        // Create a red Cycle with two wheels.
        public Bicycle() : base(2) {}    
    }
    
    public sealed class Tricycle : Cycle {
    
        // Create a red Cycle with three wheels.
        public Tricycle() : base(3) {}
    }

}
Imports System.Security.Permissions
Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Web
Imports System.Web.UI
 
Namespace Samples.AspNet.VB.Controls
    '////////////////////////////////////////////////////////////
    '
    ' The strongly typed CycleCollection class is a collection
    ' that contains Cycle class instances, which implement the
    ' IStateManager interface.
    '
    '////////////////////////////////////////////////////////////
    <AspNetHostingPermission(SecurityAction.Demand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
                   Public NotInheritable Class CycleCollection
        Inherits StateManagedCollection

        Private Shared _typesOfCycles() As Type = _
            {GetType(Bicycle), GetType(Tricycle)}

        Protected Overrides Function CreateKnownType(ByVal index As Integer) As Object
            Select Case index
                Case 0
                    Return New Bicycle()
                Case 1
                    Return New Tricycle()
                Case Else
                    Throw New ArgumentOutOfRangeException("Unknown Type")
            End Select

        End Function


        Protected Overrides Function GetKnownTypes() As Type()
            Return _typesOfCycles

        End Function


        Protected Overrides Sub SetDirtyObject(ByVal o As Object)
            CType(o, Cycle).SetDirty()

        End Sub
    End Class
    '////////////////////////////////////////////////////////////
    '
    ' The abstract Cycle class represents bicycles and tricycles.
    '
    '////////////////////////////////////////////////////////////

    MustInherit Public Class Cycle
        Implements IStateManager


        Friend Protected Sub New(ByVal numWheels As Integer) 
            MyClass.New(numWheels, "Red")

        End Sub

        Friend Protected Sub New(ByVal numWheels As Integer, ByVal color As String) 
            numOfWheels = numWheels
            CycleColor = color

        End Sub

        Private numOfWheels As Integer = 0    
        Public ReadOnly Property NumberOfWheels() As Integer 
            Get
                Return numOfWheels
            End Get
        End Property 

        Public Property CycleColor() As String 
            Get
                Dim o As Object = ViewState("Color")
                If o Is Nothing Then 
                    Return String.Empty
                Else  
                    Return o.ToString()
                End If            
            End Get
            Set
                ViewState("Color") = value
            End Set
        End Property


        Friend Sub SetDirty() 
            ViewState.SetDirty(True)

        End Sub

        ' Because Cycle does not derive from Control, it does not 
        ' have access to an inherited view state StateBag object.
        Private cycleViewState As StateBag

        Private ReadOnly Property ViewState() As StateBag 
            Get
                If cycleViewState Is Nothing Then
                    cycleViewState = New StateBag(False)
                    If trackingViewState Then
                        CType(cycleViewState, IStateManager).TrackViewState()
                    End If
                End If
                Return cycleViewState
            End Get
        End Property

        ' The IStateManager implementation.
        Private trackingViewState As Boolean

        ReadOnly Property IsTrackingViewState() As Boolean _
            Implements IStateManager.IsTrackingViewState
            Get
                Return trackingViewState
            End Get
        End Property


        Sub LoadViewState(ByVal savedState As Object) _
            Implements IStateManager.LoadViewState
            Dim cycleState As Object() = CType(savedState, Object())

            ' In SaveViewState, an array of one element is created.
            ' Therefore, if the array passed to LoadViewState has 
            ' more than one element, it is invalid.
            If cycleState.Length <> 1 Then
                Throw New ArgumentException("Invalid Cycle View State")
            End If

            ' Call LoadViewState on the StateBag object.
            CType(ViewState, IStateManager).LoadViewState(cycleState(0))

        End Sub


        ' Save the view state by calling the StateBag's SaveViewState
        ' method.
        Function SaveViewState() As Object Implements IStateManager.SaveViewState
            Dim cycleState(0) As Object

            If Not (cycleViewState Is Nothing) Then
                cycleState(0) = _
                CType(cycleViewState, IStateManager).SaveViewState()
            End If
            Return cycleState

        End Function


        ' Begin tracking view state. Check the private variable, because 
        ' if the view state has not been accessed or set, then it is not being 
        ' used and there is no reason to store any view state.
        Sub TrackViewState() Implements IStateManager.TrackViewState
            trackingViewState = True
            If Not (cycleViewState Is Nothing) Then
                CType(cycleViewState, IStateManager).TrackViewState()
            End If

        End Sub
    End Class


    Public NotInheritable Class Bicycle
        Inherits Cycle


        ' Create a red Cycle with two wheels.
        Public Sub New()
            MyBase.New(2)

        End Sub
    End Class

    Public NotInheritable Class Tricycle
        Inherits Cycle


        ' Create a red Cycle with three wheels.
        Public Sub New()
            MyBase.New(3)

        End Sub
    End Class
End Namespace

注釈

StateManagedCollection クラスは、DataControlFieldCollectionParameterCollectionStyleCollectionTreeNodeBindingCollectionなど、IStateManager 要素を格納する厳密に型指定されたすべてのコレクションの基本クラスです。The StateManagedCollection class is the base class for all strongly typed collections that store IStateManager elements, including DataControlFieldCollection, ParameterCollection, StyleCollection, TreeNodeBindingCollection, and others. StateManagedCollection コレクションは、自身の状態と、それに含まれる要素の状態を管理します。The StateManagedCollection collection manages its own state as well as the state of the elements it contains. したがって、IStateManager.SaveViewState を呼び出すと、コレクションの状態と、コレクションに現在格納されているすべての要素の状態が保存されます。Therefore, a call to IStateManager.SaveViewState saves the state of the collection and the state of all the elements currently contained by the collection.

StateManagedCollection クラスからの派生時に考慮する必要がある最も重要な方法は、CreateKnownTypeGetKnownTypesOnValidateSetDirty、および SetDirtyObjectです。The most important methods to consider when deriving from the StateManagedCollection class are CreateKnownType, GetKnownTypes, OnValidate, SetDirty, and SetDirtyObject. CreateKnownType メソッドと GetKnownTypes メソッドは、含まれている要素の型のビューステートにインデックスを格納するために使用されます。The CreateKnownType and GetKnownTypes methods are used to store an index in view state for the type of a contained element. 完全修飾型名ではなくインデックスを格納すると、パフォーマンスが向上します。Storing an index rather than a fully qualified type name improves performance. OnValidate メソッドは、コレクションの要素が操作されるたびに呼び出され、ビジネスルールに従って要素を検証します。The OnValidate method is called whenever elements of the collection are manipulated, and validates the elements according to business rules. 現時点では、OnValidate メソッドの実装により、null オブジェクトをコレクションに格納することが禁止されています。ただし、このメソッドをオーバーライドして、派生型で独自の検証動作を定義することができます。Currently, the implementation of the OnValidate method prohibits null objects from being stored in the collection; however, you can override this method to define your own validation behavior in a derived type. SetDirty メソッドは、最後に読み込まれてから状態に加えられた変更をシリアル化するだけではなく、コレクション全体を強制的にビューステートにシリアル化します。The SetDirty method forces the entire collection to be serialized to view state, rather than just serializing changes made to state since the last time it was loaded. SetDirtyObject メソッドは、要素レベルで同じ動作を実行するために実装できる抽象メソッドです。The SetDirtyObject method is an abstract method you can implement to perform this same behavior at the element level.

重要

StateManagedCollection は、コレクションアイテムのアセンブリ修飾型名をビューステートに格納します。StateManagedCollection stores assembly-qualified type names of the collection items in view state. サイトビジターは、ビューステートをデコードし、型名を取得できます。A site visitor could decode the view state and retrieve the type name. このシナリオで Web サイトにセキュリティ上の問題が生じた場合は、型名を手動で暗号化してから、ビューステートに配置することができます。If this scenario creates a security concern in your Web site, you can manually encrypt the type name before placing it in the view state.

コンストラクター

StateManagedCollection()

StateManagedCollection クラスの新しいインスタンスを初期化します。Initializes a new instance of the StateManagedCollection class.

プロパティ

Count

StateManagedCollection コレクションに格納されている要素の数を取得します。Gets the number of elements contained in the StateManagedCollection collection.

メソッド

Clear()

StateManagedCollection コレクションからすべての項目を削除します。Removes all items from the StateManagedCollection collection.

CopyTo(Array, Int32)

特定の配列インデックスを開始位置として、配列に StateManagedCollection コレクションの要素をコピーします。Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index.

CreateKnownType(Int32)

派生クラスでオーバーライドされた場合、IStateManager を実装するクラスのインスタンスを作成します。When overridden in a derived class, creates an instance of a class that implements IStateManager. 作成されるオブジェクトの型は、GetKnownTypes() メソッドから返されるコレクションの指定されたメンバーに基づきます。The type of object created is based on the specified member of the collection returned by the GetKnownTypes() method.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetEnumerator()

StateManagedCollection コレクションを反復処理する反復子を返します。Returns an iterator that iterates through the StateManagedCollection collection.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetKnownTypes()

派生クラスでオーバーライドされた場合、IStateManager コレクションに格納できる StateManagedCollection 型の配列を取得します。When overridden in a derived class, gets an array of IStateManager types that the StateManagedCollection collection can contain.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
OnClear()

派生クラスでオーバーライドされた場合、Clear() メソッドによってコレクションからすべての項目が削除される前の補足作業を実行します。When overridden in a derived class, performs additional work before the Clear() method removes all items from the collection.

OnClearComplete()

派生クラスでオーバーライドされた場合、Clear() メソッドによってコレクションからすべての項目が削除された後の補足作業を実行します。When overridden in a derived class, performs additional work after the Clear() method finishes removing all items from the collection.

OnInsert(Int32, Object)

派生クラスでオーバーライドされた場合、IList.Insert(Int32, Object) メソッドまたは IList.Add(Object) メソッドによってコレクションに項目が追加される前の補足作業を実行します。When overridden in a derived class, performs additional work before the IList.Insert(Int32, Object) or IList.Add(Object) method adds an item to the collection.

OnInsertComplete(Int32, Object)

派生クラスでオーバーライドされた場合、IList.Insert(Int32, Object) メソッドまたは IList.Add(Object) メソッドによってコレクションに項目が追加された後の補足作業を実行します。When overridden in a derived class, performs additional work after the IList.Insert(Int32, Object) or IList.Add(Object) method adds an item to the collection.

OnRemove(Int32, Object)

派生クラスでオーバーライドされた場合、IList.Remove(Object) メソッドまたは IList.RemoveAt(Int32) メソッドによって、指定された項目がコレクションから削除される前の補足作業を実行します。When overridden in a derived class, performs additional work before the IList.Remove(Object) or IList.RemoveAt(Int32) method removes the specified item from the collection.

OnRemoveComplete(Int32, Object)

派生クラスでオーバーライドされた場合、IList.Remove(Object) メソッドまたは IList.RemoveAt(Int32) メソッドによって、指定された項目がコレクションから削除された後の補足作業を実行します。When overridden in a derived class, performs additional work after the IList.Remove(Object) or IList.RemoveAt(Int32) method removes the specified item from the collection.

OnValidate(Object)

派生クラスでオーバーライドされた場合、StateManagedCollection コレクションの要素を検証します。When overridden in a derived class, validates an element of the StateManagedCollection collection.

SetDirty()

強制的に StateManagedCollection コレクション全体をビューステートにシリアル化します。Forces the entire StateManagedCollection collection to be serialized into view state.

SetDirtyObject(Object)

派生クラスでオーバーライドされた場合、コレクションに格納されている object に、変更情報だけでなく、その状態全体をビューステートに記録するよう指示します。When overridden in a derived class, instructs an object contained by the collection to record its entire state to view state, rather than recording only change information.

ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

ICollection.Count

StateManagedCollection コレクションに格納されている要素の数を取得します。Gets the number of elements contained in the StateManagedCollection collection.

ICollection.IsSynchronized

StateManagedCollection コレクションが同期されている (スレッド セーフである) かどうかを示す値を取得します。Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). このメソッドは、常に false を返します。This method returns false in all cases.

ICollection.SyncRoot

StateManagedCollection コレクションへのアクセスを同期するために使用できるオブジェクトを取得します。Gets an object that can be used to synchronize access to the StateManagedCollection collection. このメソッドは、常に null を返します。This method returns null in all cases.

IEnumerable.GetEnumerator()

StateManagedCollection コレクションを反復処理する反復子を返します。Returns an iterator that iterates through the StateManagedCollection collection.

IList.Add(Object)

項目を StateManagedCollection コレクションに追加します。Adds an item to the StateManagedCollection collection.

IList.Clear()

StateManagedCollection コレクションからすべての項目を削除します。Removes all items from the StateManagedCollection collection.

IList.Contains(Object)

StateManagedCollection コレクションに特定の値が格納されているかどうかを判断します。Determines whether the StateManagedCollection collection contains a specific value.

IList.IndexOf(Object)

StateManagedCollection コレクション内での指定した項目のインデックスを調べます。Determines the index of a specified item in the StateManagedCollection collection.

IList.Insert(Int32, Object)

StateManagedCollection コレクション内の指定したインデックスの位置に項目を挿入します。Inserts an item into the StateManagedCollection collection at the specified index.

IList.IsFixedSize

StateManagedCollection コレクションが固定サイズかどうかを示す値を取得します。Gets a value indicating whether the StateManagedCollection collection has a fixed size. このメソッドは、常に false を返します。This method returns false in all cases.

IList.IsReadOnly

StateManagedCollection コレクションが読み取り専用かどうかを示す値を取得します。Gets a value indicating whether the StateManagedCollection collection is read-only.

IList.Item[Int32]

指定したインデックス位置にある IStateManager 要素を取得します。Gets the IStateManager element at the specified index.

IList.Remove(Object)

指定したオブジェクトのうち、StateManagedCollection コレクションで最初に出現したオブジェクトを削除します。Removes the first occurrence of the specified object from the StateManagedCollection collection.

IList.RemoveAt(Int32)

指定したインデックス位置にある IStateManager 要素を削除します。Removes the IStateManager element at the specified index.

IStateManager.IsTrackingViewState

StateManagedCollection コレクションがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state.

IStateManager.LoadViewState(Object)

StateManagedCollection コレクションと、そのコレクションに格納されている IStateManager 項目の以前に保存されたビューステートを復元します。Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains.

IStateManager.SaveViewState()

ページがサーバーにポストバックされた時間以降に発生した、StateManagedCollection コレクションとその各 IStateManager オブジェクトへの変更を保存します。Saves the changes to the StateManagedCollection collection and each IStateManager object it contains since the time the page was posted back to the server.

IStateManager.TrackViewState()

StateManagedCollection コレクションとその各 IStateManager オブジェクトに自身のビューステートへの変更を追跡させ、同じページに対する要求間でこれらが永続化されるようにします。Causes the StateManagedCollection collection and each of the IStateManager objects it contains to track changes to their view state so they can be persisted across requests for the same page.

拡張メソッド

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.

適用対象

こちらもご覧ください