πŸ“˜ MonitorEditViewModel.cs Documentation


πŸ“‘ Table of Contents

  1. Overview & Purpose
  2. Namespace & Dependencies
  3. Class Diagram (UML)
  4. Key Functional Areas
  5. Usage Scenarios
  6. Sample Code Blocks
  7. Extending the ViewModel
  8. Conclusion

πŸ“‹ 1. Overview & Purpose

MonitorEditViewModel is a simple ViewModel used in the IrbyImaging.UI assembly to support the Edit screen for Monitor entities in an MVC web application. It inherits from a common base class EditViewModel, enabling reuse of shared editing properties (such as Id, potential validation flags, etc.).

Why a separate ViewModel?

  • Encapsulates data required by the Monitor editing view
  • Decouples domain models from UI concerns
  • Promotes validation, mapping, and testability

πŸ”— 2. Namespace & Dependencies

namespace IrbyImaging.Models
{
    public class MonitorEditViewModel : EditViewModel
    {
    }
}
Dependency Purpose
IrbyImaging.Models Shared models and ViewModel folder for UI layer
EditViewModel (base) Provides common edit-related properties & methods
.NET / ASP.NET Core MVC Framework used for controllers & Razor views

πŸ–₯️ 3. Class Diagram (UML)

classDiagram
    class EditViewModel {
        <<abstract>>
        +int Id
        +string? ValidationMessage
        +bool IsDirty
    }
    
    class MonitorEditViewModel {
    }
    
    EditViewModel <|-- MonitorEditViewModel

Legend:

  • β—„|-- = Inheritance
  • EditViewModel is abstract/base; MonitorEditViewModel extends it.

βš™οΈ 4. Key Functional Areas

  1. Inheritance
    • Derives from EditViewModel, obtaining shared editing properties (e.g., Id).
  2. Separation of Concerns
    • The UI layer receives a specific ViewModel tailored to Monitor edits.
  3. Extensibility
    • You can add Monitor‑specific fields (e.g., Name, Resolution) without modifying the base class.

πŸš€ 5. Usage Scenarios

5.1 In a Controller

public class MonitorController : Controller
{
    // GET: /Monitor/Edit/5
    public IActionResult Edit(int id)
    {
        // 1. Fetch domain entity
        var monitor = _monitorService.GetMonitorById(id);

        // 2. Map to ViewModel
        var viewModel = new MonitorEditViewModel
        {
            Id = monitor.Id,
            // Map additional properties here...
        };

        // 3. Return to View
        return View(viewModel);
    }

    // POST: /Monitor/Edit
    [HttpPost]
    public IActionResult Edit(MonitorEditViewModel model)
    {
        if (!ModelState.IsValid)
            return View(model);

        // Map back to domain, save, redirect
        _monitorService.Update(new MonitorDto
        {
            Id = model.Id,
            // ...
        });

        return RedirectToAction("Index");
    }
}

5.2 In a Razor View

@model IrbyImaging.Models.MonitorEditViewModel

<h2>Edit Monitor πŸ–₯️</h2>

<form asp-action="Edit" method="post">
    <input type="hidden" asp-for="Id" />

    <!-- Future properties example -->
    <!--
    <div class="form-group">
        <label asp-for="Name"></label>
        <input asp-for="Name" class="form-control" />
        <span asp-validation-for="Name" class="text-danger"></span>
    </div>
    -->

    <button type="submit" class="btn btn-primary">Save</button>
</form>

πŸ“¦ 6. Sample Code Blocks

Basic instantiation:

var vm = new MonitorEditViewModel
{
    Id = 42
};

Checking dirty state (inherited):

if (vm.IsDirty)
{
    // prompt user to save changes
}

πŸ”§ 7. Extending the ViewModel

You can enrich MonitorEditViewModel by adding monitor-specific fields:

public class MonitorEditViewModel : EditViewModel
{
    [Required(ErrorMessage = "Display name is required")]
    public string DisplayName { get; set; }

    [Range(10, 100, ErrorMessage = "Size must be between 10 and 100 inches")]
    public int SizeInInches { get; set; }

    public string Resolution { get; set; }  // e.g. 1920x1080
}

πŸ“Œ 8. Conclusion

MonitorEditViewModel.cs is a lightweight, extendable ViewModel that provides the scaffolding for an Edit Monitor UI in the IrbyImaging application. Its clear inheritance from EditViewModel encourages DRY principles, while allowing you to customize it for any Monitor‑specific editing needs. πŸš€

Feel free to extend, validate, and map to your domain model to build a robust editing experience!