StateManagedCollection クラス

.NET Framework クラス ライブラリ リファレンス

StateManagedCollection クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public MustInherit Class
 StateManagedCollection
    Implements IList, ICollection, IEnumerable, IStateManager

Visual Basic (使用法)

Dim instance As StateManagedCollection

C#

public abstract class StateManagedCollection
 : IList, ICollection, IEnumerable, 
    IStateManager

C++

public ref class StateManagedCollection abstract
 : IList, ICollection, IEnumerable, 
    IStateManager

J#

public abstract class StateManagedCollection
 implements IList, ICollection, 
    IEnumerable, IStateManager

JScript

public abstract class StateManagedCollection
 implements IList, ICollection, 
    IEnumerable, IStateManager

解説

StateManagedCollection クラスは、IStateManager 要素が格納される厳密に型指定されたすべてのコレクションの基本クラスです。たとえば、DataControlFieldCollection、ParameterCollection、StyleCollection、TreeNodeBindingCollection などがあります。StateManagedCollection コレクションは、それ自身の状態と、含まれる要素の状態とを管理します。したがって、System.Web.UI.IStateManager.SaveViewState の呼び出しによって、そのコレクションの状態と、そのコレクションに現在格納されているすべての要素の状態が保存されます。

StateManagedCollection クラスからの派生において、注意を要する重要なメソッドは CreateKnownType、GetKnownTypes、OnValidate、SetDirty、および SetDirtyObject です。CreateKnownType メソッドと GetKnownTypes メソッドは、コレクション要素の型のインデックスをビューステートに格納する目的で使用されます。完全修飾型名ではなくインデックスを格納することにより、パフォーマンスが向上します。OnValidate メソッドは、コレクションの要素が操作されるときに呼び出され、ビジネス ルールに従ってその要素を検証します。現在、OnValidate メソッドの実装により、null 参照 (Visual Basic では Nothing) オブジェクトはコレクションに格納できないようになっていますが、このメソッドをオーバーライドすることにより、派生型において独自の検証動作を定義できます。SetDirty メソッドは、前回の読み込み以降、状態に対して行われた変更のみをシリアル化するのではなく、強制的にコレクション全体をビューステートにシリアル化します。SetDirtyObject メソッドは、要素レベルでこの同じ動作を実行するために実装できる抽象メソッドです。

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

使用例

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

Visual Basic

Imports System
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

C#

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) {}
    }

}

継承階層

System.Object
  System.Web.UI.StateManagedCollection
     派生クラス

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
StateManagedCollection メンバ
System.Web.UI 名前空間
IStateManager インターフェイス
StateBag クラス