CapyKit/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md

61 lines
2.3 KiB
Markdown
Raw Normal View History

# PageCount<T>(IQueryable<T>, Int32) Method
The number of pages of *pageSize* size in the given collection.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
2024-04-21 01:20:26 -05:00
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
**C#**
``` C#
public static int PageCount<T>(
this IQueryable<T> source,
int pageSize
)
```
**F#**
``` F#
[<ExtensionAttribute>]
static member PageCount :
source : IQueryable<'T> *
pageSize : int -> int
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>Size of the page.</dd></dl>
#### Type Parameters
<dl><dt /><dd>Generic type parameter.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
An int.
#### Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
Extension Methods (C# Programming Guide)</a>.
## Exceptions
<table>
<tr>
<td><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception" target="_blank" rel="noopener noreferrer">ArgumentOutOfRangeException</a></td>
<td>Thrown when <em>pageSize</em> is less than <code>1</code>.</td></tr>
</table>
## See Also
#### Reference
<a href="T_CapyKit_Extensions_LINQExtensions">LINQExtensions Class</a>
<a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount">PageCount Overload</a>
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a>