πŸ–¨οΈ OfficePrinterListViewModel Documentation

Assembly: IrbyImaging.UI
Created By: kvamshi (03-31-2022)
Last Modified By: kvamshi (03-31-2022)


πŸ“‘ Table of Contents

  1. Overview & Purpose
  2. Dependencies & Technologies
  3. Key Functional Areas
  4. Class Definition & Inheritance
  5. Properties
  6. UML Class Diagram
  7. Usage Examples
  8. Integration Scenario
  9. Conclusion

1. Overview & Purpose

OfficePrinterListViewModel is a simple ViewModel designed to carry a collection of office printers from the server side (e.g., a controller) to the UI layer in an ASP.NET MVC or Razor Pages application.

  • πŸ” What it does:

    • Extends a generic ListViewModel base class (which typically contains pagination, sorting, or filtering properties).
    • Wraps a list (ICollection) of OfficePrinterDetailViewModel objects.
  • 🎯 Why it's useful:

    • Keeps UI concerns separate from domain entities.
    • Provides a strongly-typed object for Razor views or client‐side frameworks to render printer lists.
    • Simplifies serialization to JSON for SPA scenarios (React, Angular, Vue).

2. Dependencies & Technologies

Dependency Version / Note
.NET Framework / .NET Core β‰₯ 3.1 / .NET 5+
C# Language C# 8.0+
ASP.NET MVC / Razor Pages Any version that supports view models
IrbyImaging.Models Namespace Contains shared models and base classes
  • Base Class: IrbyImaging.Models.ListViewModel
  • Detail Model: OfficePrinterDetailViewModel (contains per-printer fields)

3. Key Functional Areas

  1. List Wrapping
    • Encapsulates a collection of OfficePrinterDetailViewModel.
  2. Inheritance
    • Inherits from ListViewModel for common list‐based properties (e.g., paging).
  3. Serialization Friendly
    • POCO design allows easy JSON/XML serialization.

4. Class Definition & Inheritance

namespace IrbyImaging.Models
{
    /// <summary>
    /// Represents a list container for office printers.
    /// Inherits common list‐based functionality from ListViewModel.
    /// </summary>
    public class OfficePrinterListViewModel : ListViewModel
    {
        /// <summary>
        /// Gets or sets the office printers.
        /// </summary>
        public ICollection<OfficePrinterDetailViewModel> OfficePrinters { get; set; }
    }
}
  • Namespace: IrbyImaging.Models
  • Inheritance:
    OfficePrinterListViewModel
        └── ListViewModel (base)
    

5. Properties

Property Name Type Description
OfficePrinters ICollection<OfficePrinterDetailViewModel> Collection of detailed printer view‐models.

Note: Properties from ListViewModel (e.g., Page, PageSize, TotalCount) are inherited and available for pagination & metadata.


6. UML Class Diagram

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   ListViewModel (base class)     β”‚
│───────────────────────────────────│
β”‚ + int Page                       β”‚
β”‚ + int PageSize                   β”‚
β”‚ + int TotalItems                 β”‚
β”‚ + string SortField               β”‚
β”‚ + string SortOrder               β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–²β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
               β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ OfficePrinterListViewModel        β”‚
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ + ICollection<OfficePrinterDetailViewModel> OfficePrinters β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

7. Usage Examples

7.1. Instantiating in Controller

public IActionResult Index(int page = 1)
{
    // Fetch data from repository or service
    var printers = _printerService.GetAllPrinters();

    // Map to detail view models
    var detailModels = printers.Select(p => new OfficePrinterDetailViewModel
    {
        Id = p.Id,
        Name = p.Name,
        Location = p.Location,
        Model = p.ModelName
    }).ToList();

    // Prepare the ListViewModel
    var vm = new OfficePrinterListViewModel
    {
        Page = page,
        PageSize = 20,
        TotalItems = printers.Count,
        OfficePrinters = detailModels
    };

    return View(vm);
}

7.2. Razor View Example

@model IrbyImaging.Models.OfficePrinterListViewModel

<h2>Office Printers πŸ“ </h2>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Location</th>
      <th>Model</th>
    </tr>
  </thead>
  <tbody>
    @foreach (var printer in Model.OfficePrinters)
    {
        <tr>
            <td>@printer.Name</td>
            <td>@printer.Location</td>
            <td>@printer.Model</td>
        </tr>
    }
  </tbody>
</table>

<div class="pagination">
    Page @Model.Page of @((Model.TotalItems + Model.PageSize - 1) / Model.PageSize)
</div>

8. Integration Scenario

  1. Service Layer
    • Fetch domain entities (Printer) from database.
  2. Mapping
    • Convert domain Printer β†’ OfficePrinterDetailViewModel.
  3. ViewModel Assembly
    • Instantiate OfficePrinterListViewModel, fill inherited paging properties, assign OfficePrinters.
  4. Controller
    • Return View(vm) or Json(vm) for AJAX calls.
  5. Client
    • Render data in Razor, or fetch via AJAX/Fetch and display in SPA.

9. Conclusion

OfficePrinterListViewModel is a lightweight, focused class designed to transport a collection of office printer details from your backend to the UI. By inheriting from a common ListViewModel, it standardizes pagination and sorting across your application. Use it in your MVC or Razor Pages to:

  • πŸ“‹ Display printer listings
  • βš™οΈ Support paging/sorting
  • πŸ”„ Serialize to JSON easily

πŸŽ‰ Happy coding with clean, maintainable ViewModels!