DataPagerFieldCollection Class (System.Web.UI.WebControls)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
DataPagerFieldCollection Class

Represents a collection of DataPagerField objects that are used by the DataPager control.

Inheritance Hierarchy
System.Object
  System.Web.UI.StateManagedCollection
    System.Web.UI.WebControls.DataPagerFieldCollection

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)
Syntax
Visual Basic
Public Class DataPagerFieldCollection _
	Inherits StateManagedCollection
C#
public class DataPagerFieldCollection : StateManagedCollection
Visual C++
public ref class DataPagerFieldCollection : public StateManagedCollection
F#
type DataPagerFieldCollection =  
    class
        inherit StateManagedCollection
    end

The DataPagerFieldCollection type exposes the following members.

Constructors
  Name Description
Public method DataPagerFieldCollection Initializes a new instance of the DataPagerFieldCollection class.
Top
Properties
  Name Description
Public property Count Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public property Item Gets the DataPagerField object that is at the specified index in the collection.
Top
Methods
  Name Description
Public method Add Appends the specified DataPagerField object to the collection.
Public method Clear Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method CloneFields Creates a copy of the current collection.
Public method Contains Determines whether the DataPagerFieldCollection collection contains the specified DataPagerField object.
Public method CopyTo(Array, Int32) Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection.)
Public method CopyTo(DataPagerField[], Int32) Copies the complete DataPagerFieldCollection collection to a one-dimensional Array object, starting at the specified index of the target array.
Protected method CreateKnownType Creates a default instance of the DataPagerField type that is identified by the provided index. (Overrides StateManagedCollection.CreateKnownType(Int32).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetKnownTypes Gets an array of DataPagerField types that the DataPagerFieldCollection collection can contain. (Overrides StateManagedCollection.GetKnownTypes().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Gets the index of a specific DataPagerField object in the collection.
Public method Insert Inserts the specified DataPagerField object into the DataPagerFieldCollection collection at the specified index.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClear When overridden in a derived class, performs additional work before the Clear method removes all items from the collection. (Inherited from StateManagedCollection.)
Protected method OnClearComplete Performs additional processing after all items are removed from the collection. (Overrides StateManagedCollection.OnClearComplete().)
Protected method OnInsert When overridden in a derived class, performs additional work before the Insert(Int32, Object) or Add(Object) method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected method OnInsertComplete Performs additional processing after an item is added to the collection. (Overrides StateManagedCollection.OnInsertComplete(Int32, Object).)
Protected method OnRemove When overridden in a derived class, performs additional work before the Remove(Object) or RemoveAt(Int32) method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected method OnRemoveComplete Performs additional processing after an item is removed from the collection. (Overrides StateManagedCollection.OnRemoveComplete(Int32, Object).)
Protected method OnValidate Verifies that the specified object is a DataPagerField object. (Overrides StateManagedCollection.OnValidate(Object).)
Public method Remove Removes the specified DataPagerField object from the DataPagerFieldCollection collection.
Public method RemoveAt Removes the DataPagerField object at the specified index from the DataPagerFieldCollection collection.
Public method SetDirty Forces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.)
Protected method SetDirtyObject Instructs the specified DataPagerField object to record its complete state to view state, instead of recording only changed information. (Overrides StateManagedCollection.SetDirtyObject(Object).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Events
  Name Description
Public event FieldsChanged Occurs when the fields in the DataPagerFieldCollection collection change.
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private property ICollection.Count Infrastructure. Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.IsSynchronized Infrastructure. Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property ICollection.SyncRoot Infrastructure. Gets an object that can be used to synchronize access to the StateManagedCollection collection. This method returns null in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IEnumerable.GetEnumerator Infrastructure. Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Add Adds an item to the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Clear Infrastructure. Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Contains Determines whether the StateManagedCollection collection contains a specific value. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.IndexOf Determines the index of a specified item in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Insert Inserts an item into the StateManagedCollection collection at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsFixedSize Infrastructure. Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.IsReadOnly Infrastructure. Gets a value indicating whether the StateManagedCollection collection is read-only. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IList.Item Infrastructure. Gets the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of the specified object from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IList.RemoveAt Removes the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Gets a value indicating whether the StateManagedCollection collection is saving changes to its view state. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.LoadViewState Restores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.SaveViewState Saves the changes to the StateManagedCollection collection and each IStateManager object it contains since the time the page was posted back to the server. (Inherited from StateManagedCollection.)
Explicit interface implemetation Private method IStateManager.TrackViewState 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. (Inherited from StateManagedCollection.)
Top
Remarks

You can use the DataPagerFieldCollection class to programmatically manage a set of DataPagerField objects. Note that it is more typical to define these fields declaratively instead of programmatically.

You can access the properties and methods of the DataPagerFieldCollection class through the DataPager.Fields property. You can add, insert, and remove DataPagerField objects by using the appropriate methods of the DataPagerFieldCollection class. To programmatically retrieve DataPagerField objects from a collection, do one of following:

The Count property gets the total number of items in the collection. It is typically used to determine the upper bound of the collection. You can add items and remove items in the collection by using the Add, Insert, Remove, and RemoveAt methods.

Version Information

.NET Framework

Supported in: 4, 3.5
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Web.UI.WebControls Namespace
DataPager
DataPagerField
ListView

Other Resources

ListView Web Server Control Overview