PagingModels 2.3.0

PagingModels

1-Indexed Data Paging Models for netstandard2.0

Install from nuget:

dotnet add package PagingModels

Classes

// Request for paged data
public class PageRequest
{
    // constructors
    public PageRequest()
    public PageRequest(int pageNumber, int pageSize)

    // properties
    public required int PageNumber { get; set; } // >= 1
    public required int PageSize { get; set; }   // >= 10 and <= 1_000_000

    // methods
    public int GetSkipCount(); // returns skip for paging on data source
}

// Paging info without actual page
public class PageCountInfo
{
    // constructors
    public PageCountInfo()
    public PageCountInfo(int pageSize, long totalTotalItemsCount)

    // properties
    public required int PageSize { get; set; }
    public required int PageCount { get; set; }
    public required long TotalItemsCount { get; set; }
}

// Paged collection with related properties
public class PagedCollection<T> : PageCountInfo, IPagedCollection
{
    // constructors
    public PagedCollection()
    public PagedCollection(IReadOnlyList<T> items, PageRequest request, long totalTotalItemsCount)

    // properties
    public required int PageSize { get; set; }
    public required int PageCount { get; set; }
    public required long TotalItemsCount { get; set; }
    public required int PageNumber { get; set; }
    public required IReadOnlyList<T> Items { get; set; }
    public bool IsFirstPage { get; }
    public bool IsLastPage { get; }
    public long ItemsFrom { get; }
    public long ItemsTo { get; }
    public int ItemsCount { get; }
}

Interface(s)

public interface IPagedCollection
{
    /// <summary>
    /// Page number
    /// </summary>
    int PageNumber { get; set; }

    /// <summary>
    /// Is this page first page
    /// </summary>
    bool IsFirstPage { get; }

    /// <summary>
    /// Is this page last page
    /// </summary>
    bool IsLastPage { get; }

    /// <summary>
    /// First item number in the collection (1-indexed)
    /// </summary>
    long ItemsFrom { get; }

    /// <summary>
    /// Last item number in the collection (1-indexed)
    /// </summary>
    long ItemsTo { get; }

    /// <summary>
    /// Page size
    /// </summary>
    int PageSize { get; set; }

    /// <summary>
    /// Number of pages, depends on <see cref="PageSize"/>
    /// </summary>
    int PageCount { get; set; }

    /// <summary>
    /// Total items count in DB or other source
    /// </summary>
    long TotalItemsCount { get; set; }

    /// <summary>
    /// Items count for current page
    /// </summary>
    int ItemsCount { get; }
}