389 lines
22 KiB
XML
389 lines
22 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>PagedList</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:PagedList.BasePagedList`1">
|
|
<summary>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</summary>
|
|
<remarks>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</remarks>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<seealso cref="T:PagedList.IPagedList`1"/>
|
|
<seealso cref="T:System.Collections.Generic.List`1"/>
|
|
</member>
|
|
<member name="T:PagedList.PagedListMetaData">
|
|
<summary>
|
|
Non-enumerable version of the PagedList class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:PagedList.IPagedList">
|
|
<summary>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</summary>
|
|
<remarks>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.PageCount">
|
|
<summary>
|
|
Total number of subsets within the superset.
|
|
</summary>
|
|
<value>
|
|
Total number of subsets within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.TotalItemCount">
|
|
<summary>
|
|
Total number of objects contained within the superset.
|
|
</summary>
|
|
<value>
|
|
Total number of objects contained within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.PageNumber">
|
|
<summary>
|
|
One-based index of this subset within the superset.
|
|
</summary>
|
|
<value>
|
|
One-based index of this subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.PageSize">
|
|
<summary>
|
|
Maximum size any individual subset.
|
|
</summary>
|
|
<value>
|
|
Maximum size any individual subset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.HasPreviousPage">
|
|
<summary>
|
|
Returns true if this is NOT the first subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is NOT the first subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.HasNextPage">
|
|
<summary>
|
|
Returns true if this is NOT the last subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is NOT the last subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.IsFirstPage">
|
|
<summary>
|
|
Returns true if this is the first subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is the first subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.IsLastPage">
|
|
<summary>
|
|
Returns true if this is the last subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is the last subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.FirstItemOnPage">
|
|
<summary>
|
|
One-based index of the first item in the paged subset.
|
|
</summary>
|
|
<value>
|
|
One-based index of the first item in the paged subset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList.LastItemOnPage">
|
|
<summary>
|
|
One-based index of the last item in the paged subset.
|
|
</summary>
|
|
<value>
|
|
One-based index of the last item in the paged subset.
|
|
</value>
|
|
</member>
|
|
<member name="M:PagedList.PagedListMetaData.#ctor">
|
|
<summary>
|
|
Protected constructor that allows for instantiation without passing in a separate list.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PagedList.PagedListMetaData.#ctor(PagedList.IPagedList)">
|
|
<summary>
|
|
Non-enumerable version of the PagedList class.
|
|
</summary>
|
|
<param name="pagedList">A PagedList (likely enumerable) to copy metadata from.</param>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.PageCount">
|
|
<summary>
|
|
Total number of subsets within the superset.
|
|
</summary>
|
|
<value>
|
|
Total number of subsets within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.TotalItemCount">
|
|
<summary>
|
|
Total number of objects contained within the superset.
|
|
</summary>
|
|
<value>
|
|
Total number of objects contained within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.PageNumber">
|
|
<summary>
|
|
One-based index of this subset within the superset.
|
|
</summary>
|
|
<value>
|
|
One-based index of this subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.PageSize">
|
|
<summary>
|
|
Maximum size any individual subset.
|
|
</summary>
|
|
<value>
|
|
Maximum size any individual subset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.HasPreviousPage">
|
|
<summary>
|
|
Returns true if this is NOT the first subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is NOT the first subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.HasNextPage">
|
|
<summary>
|
|
Returns true if this is NOT the last subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is NOT the last subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.IsFirstPage">
|
|
<summary>
|
|
Returns true if this is the first subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is the first subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.IsLastPage">
|
|
<summary>
|
|
Returns true if this is the last subset within the superset.
|
|
</summary>
|
|
<value>
|
|
Returns true if this is the last subset within the superset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.FirstItemOnPage">
|
|
<summary>
|
|
One-based index of the first item in the paged subset.
|
|
</summary>
|
|
<value>
|
|
One-based index of the first item in the paged subset.
|
|
</value>
|
|
</member>
|
|
<member name="P:PagedList.PagedListMetaData.LastItemOnPage">
|
|
<summary>
|
|
One-based index of the last item in the paged subset.
|
|
</summary>
|
|
<value>
|
|
One-based index of the last item in the paged subset.
|
|
</value>
|
|
</member>
|
|
<member name="T:PagedList.IPagedList`1">
|
|
<summary>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</summary>
|
|
<remarks>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</remarks>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<seealso cref="T:System.Collections.Generic.IEnumerable`1"/>
|
|
</member>
|
|
<member name="M:PagedList.IPagedList`1.GetMetaData">
|
|
<summary>
|
|
Gets a non-enumerable copy of this paged list.
|
|
</summary>
|
|
<returns>A non-enumerable copy of this paged list.</returns>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets the element at the specified index.
|
|
</summary>
|
|
<param name="index">The zero-based index of the element to get.</param>
|
|
</member>
|
|
<member name="P:PagedList.IPagedList`1.Count">
|
|
<summary>
|
|
Gets the number of elements contained on this page.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PagedList.BasePagedList`1.Subset">
|
|
<summary>
|
|
The subset of items contained only within this one page of the superset.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PagedList.BasePagedList`1.#ctor">
|
|
<summary>
|
|
Parameterless constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PagedList.BasePagedList`1.#ctor(System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of a type deriving from <see cref="T:PagedList.BasePagedList`1"/> and sets properties needed to calculate position and size data on the subset and superset.
|
|
</summary>
|
|
<param name="pageNumber">The one-based index of the subset of objects contained by this instance.</param>
|
|
<param name="pageSize">The maximum size of any individual subset.</param>
|
|
<param name="totalItemCount">The size of the superset.</param>
|
|
</member>
|
|
<member name="M:PagedList.BasePagedList`1.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the BasePagedList<T>.
|
|
</summary>
|
|
<returns>A BasePagedList<T>.Enumerator for the BasePagedList<T>.</returns>
|
|
</member>
|
|
<member name="M:PagedList.BasePagedList`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the BasePagedList<T>.
|
|
</summary>
|
|
<returns>A BasePagedList<T>.Enumerator for the BasePagedList<T>.</returns>
|
|
</member>
|
|
<member name="M:PagedList.BasePagedList`1.GetMetaData">
|
|
<summary>
|
|
Gets a non-enumerable copy of this paged list.
|
|
</summary>
|
|
<returns>A non-enumerable copy of this paged list.</returns>
|
|
</member>
|
|
<member name="P:PagedList.BasePagedList`1.Item(System.Int32)">
|
|
<summary>
|
|
Gets the element at the specified index.
|
|
</summary>
|
|
<param name = "index">The zero-based index of the element to get.</param>
|
|
</member>
|
|
<member name="P:PagedList.BasePagedList`1.Count">
|
|
<summary>
|
|
Gets the number of elements contained on this page.
|
|
</summary>
|
|
</member>
|
|
<member name="T:PagedList.PagedList`1">
|
|
<summary>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</summary>
|
|
<remarks>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</remarks>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<seealso cref="T:PagedList.IPagedList`1"/>
|
|
<seealso cref="T:PagedList.BasePagedList`1"/>
|
|
<seealso cref="T:PagedList.StaticPagedList`1"/>
|
|
<seealso cref="T:System.Collections.Generic.List`1"/>
|
|
</member>
|
|
<member name="M:PagedList.PagedList`1.#ctor(System.Linq.IQueryable{`0},System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:PagedList.PagedList`1"/> class that divides the supplied superset into subsets the size of the supplied pageSize. The instance then only containes the objects contained in the subset specified by index.
|
|
</summary>
|
|
<param name="superset">The collection of objects to be divided into subsets. If the collection implements <see cref="T:System.Linq.IQueryable`1"/>, it will be treated as such.</param>
|
|
<param name="pageNumber">The one-based index of the subset of objects to be contained by this instance.</param>
|
|
<param name="pageSize">The maximum size of any individual subset.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified index cannot be less than zero.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified page size cannot be less than one.</exception>
|
|
</member>
|
|
<member name="M:PagedList.PagedList`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:PagedList.PagedList`1"/> class that divides the supplied superset into subsets the size of the supplied pageSize. The instance then only containes the objects contained in the subset specified by index.
|
|
</summary>
|
|
<param name="superset">The collection of objects to be divided into subsets. If the collection implements <see cref="T:System.Linq.IQueryable`1"/>, it will be treated as such.</param>
|
|
<param name="pageNumber">The one-based index of the subset of objects to be contained by this instance.</param>
|
|
<param name="pageSize">The maximum size of any individual subset.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified index cannot be less than zero.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified page size cannot be less than one.</exception>
|
|
</member>
|
|
<member name="T:PagedList.PagedListExtensions">
|
|
<summary>
|
|
Container for extension methods designed to simplify the creation of instances of <see cref="T:PagedList.PagedList`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PagedList.PagedListExtensions.ToPagedList``1(System.Collections.Generic.IEnumerable{``0},System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates a subset of this collection of objects that can be individually accessed by index and containing metadata about the collection of objects the subset was created from.
|
|
</summary>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<param name="superset">The collection of objects to be divided into subsets. If the collection implements <see cref="T:System.Linq.IQueryable`1"/>, it will be treated as such.</param>
|
|
<param name="pageNumber">The one-based index of the subset of objects to be contained by this instance.</param>
|
|
<param name="pageSize">The maximum size of any individual subset.</param>
|
|
<returns>A subset of this collection of objects that can be individually accessed by index and containing metadata about the collection of objects the subset was created from.</returns>
|
|
<seealso cref="T:PagedList.PagedList`1"/>
|
|
</member>
|
|
<member name="M:PagedList.PagedListExtensions.ToPagedList``1(System.Linq.IQueryable{``0},System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates a subset of this collection of objects that can be individually accessed by index and containing metadata about the collection of objects the subset was created from.
|
|
</summary>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<param name="superset">The collection of objects to be divided into subsets. If the collection implements <see cref="T:System.Linq.IQueryable`1"/>, it will be treated as such.</param>
|
|
<param name="pageNumber">The one-based index of the subset of objects to be contained by this instance.</param>
|
|
<param name="pageSize">The maximum size of any individual subset.</param>
|
|
<returns>A subset of this collection of objects that can be individually accessed by index and containing metadata about the collection of objects the subset was created from.</returns>
|
|
<seealso cref="T:PagedList.PagedList`1"/>
|
|
</member>
|
|
<member name="M:PagedList.PagedListExtensions.Split``1(System.Collections.Generic.IEnumerable{``0},System.Int32)">
|
|
<summary>
|
|
Splits a collection of objects into n pages with an (for example, if I have a list of 45 shoes and say 'shoes.Split(5)' I will now have 4 pages of 10 shoes and 1 page of 5 shoes.
|
|
</summary>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<param name="superset">The collection of objects to be divided into subsets.</param>
|
|
<param name="numberOfPages">The number of pages this collection should be split into.</param>
|
|
<returns>A subset of this collection of objects, split into n pages.</returns>
|
|
</member>
|
|
<member name="M:PagedList.PagedListExtensions.Partition``1(System.Collections.Generic.IEnumerable{``0},System.Int32)">
|
|
<summary>
|
|
Splits a collection of objects into an unknown number of pages with n items per page (for example, if I have a list of 45 shoes and say 'shoes.Partition(10)' I will now have 4 pages of 10 shoes and 1 page of 5 shoes.
|
|
</summary>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<param name="superset">The collection of objects to be divided into subsets.</param>
|
|
<param name="pageSize">The maximum number of items each page may contain.</param>
|
|
<returns>A subset of this collection of objects, split into pages of maximum size n.</returns>
|
|
</member>
|
|
<member name="T:PagedList.StaticPagedList`1">
|
|
<summary>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</summary>
|
|
<remarks>
|
|
Represents a subset of a collection of objects that can be individually accessed by index and containing metadata about the superset collection of objects this subset was created from.
|
|
</remarks>
|
|
<typeparam name="T">The type of object the collection should contain.</typeparam>
|
|
<seealso cref="T:PagedList.IPagedList`1"/>
|
|
<seealso cref="T:PagedList.BasePagedList`1"/>
|
|
<seealso cref="T:PagedList.PagedList`1"/>
|
|
<seealso cref="T:System.Collections.Generic.List`1"/>
|
|
</member>
|
|
<member name="M:PagedList.StaticPagedList`1.#ctor(System.Collections.Generic.IEnumerable{`0},PagedList.IPagedList)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:PagedList.StaticPagedList`1"/> class that contains the already divided subset and information about the size of the superset and the subset's position within it.
|
|
</summary>
|
|
<param name="subset">The single subset this collection should represent.</param>
|
|
<param name="metaData">Supply the ".MetaData" property of an existing IPagedList instance to recreate it here (such as when creating a new instance of a PagedList after having used Automapper to convert its contents to a DTO.)</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified index cannot be less than zero.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified page size cannot be less than one.</exception>
|
|
</member>
|
|
<member name="M:PagedList.StaticPagedList`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:PagedList.StaticPagedList`1"/> class that contains the already divided subset and information about the size of the superset and the subset's position within it.
|
|
</summary>
|
|
<param name="subset">The single subset this collection should represent.</param>
|
|
<param name="pageNumber">The one-based index of the subset of objects contained by this instance.</param>
|
|
<param name="pageSize">The maximum size of any individual subset.</param>
|
|
<param name="totalItemCount">The size of the superset.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified index cannot be less than zero.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The specified page size cannot be less than one.</exception>
|
|
</member>
|
|
</members>
|
|
</doc>
|