PagedDataSource Class

.NET Framework (current version)

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)

Inheritance Hierarchy

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

Syntax

C++

[<Sealed>]
type PagedDataSource = 
    class
        interface ICollection
        interface IEnumerable
        interface ITypedList
    end

Constructors

	Name	Description
	PagedDataSource()	Initializes a new instance of the PagedDataSource class.

Properties

	Name	Description
	AllowCustomPaging	Gets or sets a value indicating whether custom paging is enabled in a data-bound control.
	AllowPaging	Gets or sets a value indicating whether paging is enabled in a data-bound control.
	AllowServerPaging	Gets or sets a value indicating whether server-side paging is enabled.
	Count	Gets the number of items to be used from the data source.
	CurrentPageIndex	Gets or sets the index of the current page.
	DataSource	Gets or sets the data source.
	DataSourceCount	Gets the number of items in the data source.
	FirstIndexInPage	Gets the index of the first record displayed on the page.
	IsCustomPagingEnabled	Gets a value indicating whether custom paging is enabled.
	IsFirstPage	Gets a value indicating whether the current page is the first page.
	IsLastPage	Gets a value indicating whether the current page is the last page.
	IsPagingEnabled	Gets a value indicating whether paging is enabled.
	IsReadOnly	Gets a value indicating whether the data source is read-only.
	IsServerPagingEnabled	Gets a value indicating whether server-side paging support is enabled.
	IsSynchronized	Gets a value indicating whether access to the data source is synchronized (thread-safe).
	PageCount	Gets the total number of pages necessary to display all items in the data source.
	PageSize	Gets or sets the number of items to display on a single page.
	SyncRoot	Gets the object that can be used to synchronize access to the collection.
	VirtualCount	Gets or sets the virtual number of items in the data source when custom paging is used.

Methods

	Name	Description
	CopyTo(Array, Int32)	Copies all the items from the data source to the specified System.Array, starting at the specified index in the System.Array.
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	GetEnumerator()	Returns a System.Collections.IEnumerator implemented object that contains all items in the data source.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetItemProperties(PropertyDescriptor[])	Returns the System.ComponentModel.PropertyDescriptorCollection that represents the properties on each item used to bind data.
	GetListName(PropertyDescriptor[])	Returns the name of the list. This method does not apply to this class.
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Extension Methods

	Name	Description
	AsParallel()	Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)
	AsQueryable()	Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)
	Cast<'TResult>()	Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)
	OfType<'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.

Version Information

.NET Framework
Available since 1.1

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.