ISqlModelMapper.LoadByPage<TModel>(int currentIndex, int pageSize, params object[] parameters) Method

.NET Standard 2.x

Retrieves data for the specified page according to the SQL query defined in a TModel class.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

  public ILoadable<TModel> LoadByPage<TModel>(int currentIndex, int pageSize, params object[] parameters);

Type Parameters

TModel

The type of a model class.

Parameters

currentIndex System.Int32

The zero-based index of the first record in the page.

pageSize System.Int32

The count of rows in each page.

parameters System.Object[]

(Optional) One or more values that you want to use as retrieval arguments in the SQL SELECT statement defined in TModel.

Returns

SnapObjects.Data.ILoadable<TModel>

Returns the ILoadable<TModel> interface whose methods can be used to further obtain the result set, or perform data operations such as embedded queries.

Examples

The following code example demonstrates how to load the specified page according to the SQL query defined in the Department class.

using SnapObjects.Data;
using Appeon.ApiDoc.Models.School;
using System;
using System.Collections.Generic;

namespace Appeon.ApiDoc.ISqlModelMapperExamples
{
    public class LoadByPageExample
    {
        private SchoolContext _context;

        public LoadByPageExample(SchoolContext dataContext)
        {
            // Sets the data context.
            _context = dataContext;
        }

        public void Example()
        {
            var mapper = _context.SqlModelMapper;

            // Loads the departments.
            var depts = mapper.Load<Department>().ToList();

            Console.WriteLine("All departments:");
            foreach (var department in depts)
            {
                Console.WriteLine(department.Name);
            }

            Console.WriteLine();

            // Loads the first page (2 records per page)
            var deptsPage1 = mapper.LoadByPage<Department>(0, 2).ToList();

            Console.WriteLine("Departments (Page 1):");
            foreach (var department in deptsPage1)
            {
                Console.WriteLine(department.Name);
            }

            /* The code produces the following output:
            
            All departments:
            Engineering
            English
            Economics
            Mathematics

            Departments (Page 1):
            Engineering
            English
            */
        }
    }
}

Example Refer To

Model Class: Department

Applies to

.NET Standard

2.x