π¨οΈ OfficePrinterListViewModel Documentation
Assembly: IrbyImaging.UI
Created By: kvamshi (03-31-2022)
Last Modified By: kvamshi (03-31-2022)
π Table of Contents
- Overview & Purpose
- Dependencies & Technologies
- Key Functional Areas
- Class Definition & Inheritance
- Properties
- UML Class Diagram
- Usage Examples
- Integration Scenario
- 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
ListViewModelbase class (which typically contains pagination, sorting, or filtering properties). - Wraps a list (
ICollection) ofOfficePrinterDetailViewModelobjects.
- Extends a generic
-
π― 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
- List Wrapping
- Encapsulates a collection of
OfficePrinterDetailViewModel.
- Encapsulates a collection of
- Inheritance
- Inherits from
ListViewModelfor common listβbased properties (e.g., paging).
- Inherits from
- 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
- Service Layer
- Fetch domain entities (
Printer) from database.
- Fetch domain entities (
- Mapping
- Convert domain
PrinterβOfficePrinterDetailViewModel.
- Convert domain
- ViewModel Assembly
- Instantiate
OfficePrinterListViewModel, fill inherited paging properties, assignOfficePrinters.
- Instantiate
- Controller
- Return
View(vm)orJson(vm)for AJAX calls.
- Return
- 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!