CapyKit/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__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.3 KiB

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

The number of pages of pageSize size in the given collection.

Definition

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

C#

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

F#

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

Parameters

  IEnumerable(T)
The source to act on.
  Int32
Size of the page.

Type Parameters

Generic type parameter.

Return Value

Int32
An int.

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).

Exceptions

ArgumentOutOfRangeException Thrown when pageSize is less than 1.

See Also

Reference

LINQExtensions Class
PageCount Overload
CapyKit.Extensions Namespace