Export (0) Print
Expand All

DataPagerFieldCollection Class

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

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)

public class DataPagerFieldCollection : StateManagedCollection

The DataPagerFieldCollection type exposes the following members.

  NameDescription
Public methodDataPagerFieldCollectionInitializes a new instance of the DataPagerFieldCollection class.
Top

  NameDescription
Public propertyCountGets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public propertyItemGets the DataPagerField object that is at the specified index in the collection.
Top

  NameDescription
Public methodAddAppends the specified DataPagerField object to the collection.
Public methodClearRemoves all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public methodCloneFieldsCreates a copy of the current collection.
Public methodContainsDetermines whether the DataPagerFieldCollection collection contains the specified DataPagerField object.
Public methodCopyTo(Array, Int32)Copies the elements of the StateManagedCollection collection to an array, starting at a particular array index. (Inherited from StateManagedCollection.)
Public methodCopyTo(DataPagerField[], Int32)Copies the complete DataPagerFieldCollection collection to a one-dimensional Array object, starting at the specified index of the target array.
Protected methodCreateKnownTypeCreates a default instance of the DataPagerField type that is identified by the provided index. (Overrides StateManagedCollection.CreateKnownType(Int32).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetKnownTypesGets an array of DataPagerField types that the DataPagerFieldCollection collection can contain. (Overrides StateManagedCollection.GetKnownTypes().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfGets the index of a specific DataPagerField object in the collection.
Public methodInsertInserts the specified DataPagerField object into the DataPagerFieldCollection collection at the specified index.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnClearWhen overridden in a derived class, performs additional work before the Clear method removes all items from the collection. (Inherited from StateManagedCollection.)
Protected methodOnClearCompletePerforms additional processing after all items are removed from the collection. (Overrides StateManagedCollection.OnClearComplete().)
Protected methodOnInsertWhen overridden in a derived class, performs additional work before the Insert or Add method adds an item to the collection. (Inherited from StateManagedCollection.)
Protected methodOnInsertCompletePerforms additional processing after an item is added to the collection. (Overrides StateManagedCollection.OnInsertComplete(Int32, Object).)
Protected methodOnRemoveWhen overridden in a derived class, performs additional work before the Remove or RemoveAt method removes the specified item from the collection. (Inherited from StateManagedCollection.)
Protected methodOnRemoveCompletePerforms additional processing after an item is removed from the collection. (Overrides StateManagedCollection.OnRemoveComplete(Int32, Object).)
Protected methodOnValidateVerifies that the specified object is a DataPagerField object. (Overrides StateManagedCollection.OnValidate(Object).)
Public methodRemoveRemoves the specified DataPagerField object from the DataPagerFieldCollection collection.
Public methodRemoveAtRemoves the DataPagerField object at the specified index from the DataPagerFieldCollection collection.
Public methodSetDirtyForces the entire StateManagedCollection collection to be serialized into view state. (Inherited from StateManagedCollection.)
Protected methodSetDirtyObjectInstructs the specified DataPagerField object to record its complete state to view state, instead of recording only changed information. (Overrides StateManagedCollection.SetDirtyObject(Object).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventFieldsChangedOccurs when the fields in the DataPagerFieldCollection collection change.
Top

  NameDescription
Explicit interface implemetationPrivate propertyICollection.CountInfrastructure. Gets the number of elements contained in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedInfrastructure. Gets a value indicating whether the StateManagedCollection collection is synchronized (thread safe). This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate propertyICollection.SyncRootInfrastructure. 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 implemetationPrivate methodIEnumerable.GetEnumeratorInfrastructure. Returns an iterator that iterates through the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.AddAdds an item to the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.ClearInfrastructure. Removes all items from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.ContainsDetermines whether the StateManagedCollection collection contains a specific value. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.IndexOfDetermines the index of a specified item in the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.InsertInserts an item into the StateManagedCollection collection at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate propertyIList.IsFixedSizeInfrastructure. Gets a value indicating whether the StateManagedCollection collection has a fixed size. This method returns false in all cases. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate propertyIList.IsReadOnlyInfrastructure. Gets a value indicating whether the StateManagedCollection collection is read-only. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate propertyIList.ItemInfrastructure. Gets the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.RemoveRemoves the first occurrence of the specified object from the StateManagedCollection collection. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIList.RemoveAtRemoves the IStateManager element at the specified index. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateGets a value indicating whether the StateManagedCollection collection is saving changes to its view state. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateRestores the previously saved view state of the StateManagedCollection collection and the IStateManager items it contains. (Inherited from StateManagedCollection.)
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateSaves 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 implemetationPrivate methodIStateManager.TrackViewStateCauses 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

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.

.NET Framework

Supported in: 4.6, 4, 3.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft