CapyKit/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md
Jordan Wages 87bd044b31 Settings Helper + Documentation
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer.

Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
2024-04-22 18:28:21 -05:00

2.7 KiB

Page<T>(IQueryable<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.0

C#

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

F#

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

Parameters

  IQueryable(T)
The source to act on.
  Int32
The page number to retrieve.
  Int32
.

Type Parameters

Generic type parameter.

Return Value

IQueryable(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 IQueryable(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