StateManagedCollection クラス

リファレンス

定義

名前空間:: System.Web.UI

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

重要

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

IStateManager オブジェクトを管理する厳密に型指定されたすべてのコレクションの基本クラスを提供します。

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

継承: Object
StateManagedCollection

派生: System.Web.UI.WebControls.DataControlFieldCollection

System.Web.UI.WebControls.DataPagerFieldCollection

System.Web.UI.WebControls.Expressions.DataSourceExpressionCollection

System.Web.UI.WebControls.HotSpotCollection

System.Web.UI.WebControls.MenuItemBindingCollection

その他…

実装: ICollection IEnumerable IList IStateManager

例

次のコード例は、厳密に型指定されたコレクションクラス StateManagedCollection を派生してオブジェクトを格納 IStateManager する方法を示しています。この例では、CycleCollection抽象Cycleクラスのインスタンス (オブジェクトのいずれかBicycle``Tricycle) を含めるために派生しています。このクラスは Cycle 、プロパティの値を IStateManager ビューステートに格納するため、インターフェイスを CycleColor 実装します。

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クラスは、要素を格納IStateManagerするすべての厳密に型指定されたコレクションの基底クラスです。たとえばDataControlFieldCollection、、、ParameterCollection StyleCollection、TreeNodeBindingCollection、などです。コレクションは StateManagedCollection 、独自の状態と、コレクションに含まれる要素の状態を管理します。したがって、コレクションの状態と、コレクションに現在含まれているすべての要素の状態を保存する IStateManager.SaveViewState 呼び出し。

クラスから StateManagedCollection 派生する際に考慮すべき最も重要なメソッドは CreateKnownType、, GetKnownTypes, , OnValidate, SetDirtyおよび SetDirtyObject. およびCreateKnownType GetKnownTypesメソッドは、包含要素の型のビューステートにインデックスを格納するために使用されます。完全修飾型名ではなくインデックスを格納すると、パフォーマンスが向上します。このメソッドは OnValidate 、コレクションの要素が操作されるたびに呼び出され、ビジネスルールに従って要素を検証します。現時点では、メソッドの OnValidate 実装ではオブジェクトがコレクションに格納されるのを禁止 null しています。ただし、このメソッドをオーバーライドして、派生型で独自の検証動作を定義できます。このメソッドは SetDirty 、前回の読み込み以降に行われた変更をシリアル化するのではなく、コレクション全体を強制的にシリアル化して状態を表示します。このメソッドは SetDirtyObject 、要素レベルで同じ動作を実行するために実装できる抽象メソッドです。

重要

StateManagedCollection は、コレクション項目のアセンブリ修飾型名をビューステートに格納します。サイト訪問者はビューステートをデコードし、タイプ名を取得できます。このシナリオによって Web サイトにセキュリティ上の問題が発生する場合は、型名を手動で暗号化してからビューステートに配置できます。

コンストラクター

StateManagedCollection()

StateManagedCollection クラスの新しいインスタンスを初期化します。

プロパティ

Count

StateManagedCollection コレクションに格納されている要素の数を取得します。

メソッド

Clear()	StateManagedCollection コレクションからすべての項目を削除します。
CopyTo(Array, Int32)	特定の配列インデックスを開始位置として、配列に StateManagedCollection コレクションの要素をコピーします。
CreateKnownType(Int32)	派生クラスでオーバーライドされた場合、IStateManager を実装するクラスのインスタンスを作成します。作成されるオブジェクトの型は、GetKnownTypes() メソッドから返されるコレクションの指定されたメンバーに基づきます。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetEnumerator()	StateManagedCollection コレクションを反復処理する反復子を返します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetKnownTypes()	派生クラスでオーバーライドされた場合、StateManagedCollection コレクションに格納できる IStateManager 型の配列を取得します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnClear()	派生クラスでオーバーライドされた場合、Clear() メソッドによってコレクションからすべての項目が削除される前の補足作業を実行します。
OnClearComplete()	派生クラスでオーバーライドされた場合、Clear() メソッドによってコレクションからすべての項目が削除された後の補足作業を実行します。
OnInsert(Int32, Object)	派生クラスでオーバーライドされた場合、IList.Insert(Int32, Object) メソッドまたは IList.Add(Object) メソッドによってコレクションに項目が追加される前の補足作業を実行します。
OnInsertComplete(Int32, Object)	派生クラスでオーバーライドされた場合、IList.Insert(Int32, Object) メソッドまたは IList.Add(Object) メソッドによってコレクションに項目が追加された後の補足作業を実行します。
OnRemove(Int32, Object)	派生クラスでオーバーライドされた場合、IList.Remove(Object) メソッドまたは IList.RemoveAt(Int32) メソッドによって、指定された項目がコレクションから削除される前の補足作業を実行します。
OnRemoveComplete(Int32, Object)	派生クラスでオーバーライドされた場合、IList.Remove(Object) メソッドまたは IList.RemoveAt(Int32) メソッドによって、指定された項目がコレクションから削除された後の補足作業を実行します。
OnValidate(Object)	派生クラスでオーバーライドされた場合、StateManagedCollection コレクションの要素を検証します。
SetDirty()	強制的に StateManagedCollection コレクション全体をビューステートにシリアル化します。
SetDirtyObject(Object)	派生クラスでオーバーライドされた場合、コレクションに格納されている `object` に、変更情報だけでなく、その状態全体をビューステートに記録するよう指示します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

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

ICollection.Count	StateManagedCollection コレクションに格納されている要素の数を取得します。
ICollection.IsSynchronized	StateManagedCollection コレクションが同期されている (スレッドセーフである) かどうかを示す値を取得します。このメソッドは、常に `false` を返します。
ICollection.SyncRoot	StateManagedCollection コレクションへのアクセスを同期するために使用できるオブジェクトを取得します。このメソッドは、常に `null` を返します。
IEnumerable.GetEnumerator()	StateManagedCollection コレクションを反復処理する反復子を返します。
IList.Add(Object)	項目を StateManagedCollection コレクションに追加します。
IList.Clear()	StateManagedCollection コレクションからすべての項目を削除します。
IList.Contains(Object)	StateManagedCollection コレクションに特定の値が格納されているかどうかを判断します。
IList.IndexOf(Object)	StateManagedCollection コレクション内での指定した項目のインデックスを調べます。
IList.Insert(Int32, Object)	StateManagedCollection コレクション内の指定したインデックスの位置に項目を挿入します。
IList.IsFixedSize	StateManagedCollection コレクションが固定サイズかどうかを示す値を取得します。このメソッドは、常に `false` を返します。
IList.IsReadOnly	StateManagedCollection コレクションが読み取り専用かどうかを示す値を取得します。
IList.Item[Int32]	指定されたインデックス位置の IStateManager 要素を取得します。
IList.Remove(Object)	指定したオブジェクトのうち、StateManagedCollection コレクションで最初に出現したオブジェクトを削除します。
IList.RemoveAt(Int32)	指定したインデックス位置にある IStateManager 要素を削除します。
IStateManager.IsTrackingViewState	StateManagedCollection コレクションがビューステートへの変更を保存しているかどうかを示す値を取得します。
IStateManager.LoadViewState(Object)	StateManagedCollection コレクションと、そのコレクションに格納されている IStateManager 項目の以前に保存されたビューステートを復元します。
IStateManager.SaveViewState()	ページがサーバーにポストバックされた時間以降に発生した、StateManagedCollection コレクションとその各 IStateManager オブジェクトへの変更を保存します。
IStateManager.TrackViewState()	StateManagedCollection コレクションとその各 IStateManager オブジェクトに自身のビューステートへの変更を追跡させ、同じページに対する要求間でこれらが永続化されるようにします。

拡張メソッド

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

適用対象

製品	バージョン
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8

次の方法で共有