CapyKit/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md

Page<T>(IEnumerable<T>, Int32, Int32) Method

Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.

Definition

Namespace: CapyKit.Extensions
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.2

C#

public static IEnumerable<T> Page<T>(
	this IEnumerable<T> source,
	int pageNumber,
	int pageSize
)

F#

[<ExtensionAttribute>]
static member Page : 
        source : IEnumerable<'T> * 
        pageNumber : int * 
        pageSize : int -> IEnumerable<'T> 

Parameters

  IEnumerable(T)

The source to act on.

  Int32

The page number to retrieve.

  Int32

Number of items per page.

Type Parameters

Generic type parameter.

Return Value

IEnumerable(T)
An enumerator that allows foreach to be used to process page in this collection.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see

Extension Methods (Visual Basic) or

Extension Methods (C# Programming Guide).

Remarks

This method uses natural numbering starting at page 1.

Exceptions

ArgumentOutOfRangeException

Thrown when pageNumber is less than 1 or if pageSize is less than 1.

See Also

Reference

LINQExtensions Class
Page Overload
CapyKit.Extensions Namespace