StateManagedCollection Класс

Определение

Пространство имен:

System.Web.UI

Сборка:

System.Web.dll

Предоставляет базовый класс для всех строго типизированных коллекций, управляющих объектами 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

System.Web.UI.WebControls.MenuItemStyleCollection

System.Web.UI.WebControls.ParameterCollection

System.Web.UI.WebControls.StyleCollection

System.Web.UI.WebControls.SubMenuStyleCollection

System.Web.UI.WebControls.TreeNodeBindingCollection

System.Web.UI.WebControls.TreeNodeStyleCollection

Реализации

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, и StyleCollectionTreeNodeBindingCollectionдругие. Коллекция StateManagedCollection управляет собственным состоянием, а также состоянием содержащихся в ней элементов. Таким образом, вызов сохраняет IStateManager.SaveViewState состояние коллекции и состояние всех элементов, содержащихся в коллекции.

Наиболее важными методами, которые следует учитывать при наследовательстве от StateManagedCollection класса, являются CreateKnownType, GetKnownTypes, OnValidateи SetDirtySetDirtyObject. GetKnownTypes Методы CreateKnownType используются для хранения индекса в состоянии представления для типа автономного элемента. Хранение индекса, а не полного имени типа повышает производительность. Метод OnValidate вызывается при каждом манипулировании элементами коллекции и проверяет элементы в соответствии с бизнес-правилами. В настоящее время реализация OnValidate метода запрещает null хранить объекты в коллекции. Однако этот метод можно переопределить, чтобы определить собственное поведение проверки в производном типе. Метод SetDirty заставляет всю коллекцию сериализоваться для просмотра состояния, а не просто сериализации изменений, внесенных в состояние с момента последней загрузки. Этот SetDirtyObject метод является абстрактным методом, который можно реализовать для выполнения такого же поведения на уровне элемента.

Важно!

StateManagedCollection сохраняет имена типов с указанием сборки элементов коллекции в состоянии представления. Посетитель сайта может декодировать состояние представления и получить имя типа. Если в этом сценарии на веб-сайте создается проблема безопасности, можно вручную зашифровать имя типа, прежде чем поместить его в состояние представления.

Конструкторы

StateManagedCollection()

Инициализирует новый экземпляр класса StateManagedCollection.

Свойства

Count

Получает количество элементов, содержащихся в коллекции StateManagedCollection.

Методы

Clear()	Удаляет все элементы из коллекции StateManagedCollection.
CopyTo(Array, Int32)	Копирует элементы коллекции StateManagedCollection в массив, начиная с определенного индекса в массиве.
CreateKnownType(Int32)	При переопределении в производном классе создает экземпляр класса, реализующий IStateManager. Тип созданного объекта основан на указанном элементе коллекции, возвращенном методом GetKnownTypes().
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetEnumerator()	Возвращает итератор, осуществляющий перебор коллекции StateManagedCollection.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetKnownTypes()	При переопределении в производном классе получает массив типов IStateManager, которые может содержать коллекция StateManagedCollection.
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.

См. также раздел

• IStateManager
• StateBag