PagedDataSource Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Encapsulates the paging-related properties of a data-bound control (such as DataGrid, GridView, DetailsView, and FormView) that allow it to perform paging. This class cannot be inherited.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

System::Object
  System.Web.UI.WebControls::PagedDataSource

public ref class PagedDataSource sealed : ICollection, IEnumerable, 
	ITypedList

NameDescription
System_CAPS_pubmethodPagedDataSource()

Initializes a new instance of the PagedDataSource class.

NameDescription
System_CAPS_pubpropertyAllowCustomPaging

Gets or sets a value indicating whether custom paging is enabled in a data-bound control.

System_CAPS_pubpropertyAllowPaging

Gets or sets a value indicating whether paging is enabled in a data-bound control.

System_CAPS_pubpropertyAllowServerPaging

Gets or sets a value indicating whether server-side paging is enabled.

System_CAPS_pubpropertyCount

Gets the number of items to be used from the data source.

System_CAPS_pubpropertyCurrentPageIndex

Gets or sets the index of the current page.

System_CAPS_pubpropertyDataSource

Gets or sets the data source.

System_CAPS_pubpropertyDataSourceCount

Gets the number of items in the data source.

System_CAPS_pubpropertyFirstIndexInPage

Gets the index of the first record displayed on the page.

System_CAPS_pubpropertyIsCustomPagingEnabled

Gets a value indicating whether custom paging is enabled.

System_CAPS_pubpropertyIsFirstPage

Gets a value indicating whether the current page is the first page.

System_CAPS_pubpropertyIsLastPage

Gets a value indicating whether the current page is the last page.

System_CAPS_pubpropertyIsPagingEnabled

Gets a value indicating whether paging is enabled.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the data source is read-only.

System_CAPS_pubpropertyIsServerPagingEnabled

Gets a value indicating whether server-side paging support is enabled.

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the data source is synchronized (thread-safe).

System_CAPS_pubpropertyPageCount

Gets the total number of pages necessary to display all items in the data source.

System_CAPS_pubpropertyPageSize

Gets or sets the number of items to display on a single page.

System_CAPS_pubpropertySyncRoot

Gets the object that can be used to synchronize access to the collection.

System_CAPS_pubpropertyVirtualCount

Gets or sets the virtual number of items in the data source when custom paging is used.

NameDescription
System_CAPS_pubmethodCopyTo(Array^, Int32)

Copies all the items from the data source to the specified System::Array, starting at the specified index in the System::Array.

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetEnumerator()

Returns a System.Collections::IEnumerator implemented object that contains all items in the data source.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetItemProperties(array<PropertyDescriptor^>^)

Returns the System.ComponentModel::PropertyDescriptorCollection that represents the properties on each item used to bind data.

System_CAPS_pubmethodGetListName(array<PropertyDescriptor^>^)

Returns the name of the list. This method does not apply to this class.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

The PagedDataSource class encapsulates the properties that allow data-source controls, such as the DataGrid, GridView, DetailsView, and FormView, to perform paging. This class is used by control developers when providing paging support to a custom data-bound control.

This class uses the best available method to enumerate over the data belonging to the current page. If the underlying data source supports indexed access (such as System::Array and System.Collections::IList), this class uses it. Otherwise, it uses the enumerator created by the GetEnumerator method.

For a list of initial property values for an instance of PagedDataSource, see the PagedDataSource constructor.

.NET Framework
Available since 1.1

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

Return to top
Show: