ILoadable.IncludeAll(bool cascade = false); Method

.NET Standard 2.x

Loads data for the embedded properties in TModel for all rows.

If the ModelEmbedded attribute is applied in the property, the property will use the SQL query (defined in the detail model class specified by the ModelType property of the ModelEmbedded attribute) to retrieve data from database. The cascade parameter can be used to decide whether to retrieve data for the embedded properties in the detail model or the granddetail model.

Namespace: SnapObjects.Data

Assembly: SnapObjects.Data.dll

Syntax

  ILoadable<TModel> IncludeAll(bool cascade = false);

Parameters

cascade System.Boolean

Only when the ModelEmbedded attribute is applied in the property, the cascade parameter can be used to decide whether to retrieve data for the embedded properties in the detail model or the granddetail model. See master-detail-granddetail for more info.

The default value is false.

Returns

SnapObjects.Data.ILoadable<TModel>

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

Examples

The following code example demonstrates how to load the details about the Poetry course.

using Appeon.ApiDoc.Models.School;
using System;

namespace Appeon.ApiDoc.ILoadableExamples
{
    public class IncludeAllExample
    {
        private SchoolContext _context;

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

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

            // Loads students, instructor, online flag for the Poetry course 
            // (CourseID = 2030).
            var course = mapper.LoadByKey<CourseInfo>(2030)
                                .IncludeAll()
                                .FirstOrDefault();

            Console.WriteLine("Courses: {0}", course.Title);

            // Students of the Poetry course. 
            Console.WriteLine();
            Console.WriteLine("Student IDs:");
            foreach (CourseStudentInfo student in course.Students)
            {
                Console.WriteLine(student.StudentID);
            }

            // Instructors of the Poetry course. 
            Console.WriteLine();
            Console.WriteLine("Instructor ID(s):");

            foreach (CourseInstructorInfo instructor in course.Instructors)
            {
                Console.WriteLine(instructor.PersonID);
            }

            /* This code produces the following output:

            Courses: Poetry

            Student IDs:
            2
            3

            Instructor ID(s):
            4
            */
        }
    }
}

Example Refer To

Model Classes: CourseInfo CourseStudentInfo CourseInstructorInfo

Applies to

.NET Standard

2.x