📝 Documentation: IrbyImaging/Views/Docks/Create.cshtml

File Path: IrbyImaging/Views/Docks/Create.cshtml
ViewModel: DockCreateViewModel
Purpose: Render a "Create New Dock" form in an ASP.NET Core MVC application.


📖 Table of Contents

  1. 🚀 Overview & Purpose
  2. ⚙️ Layout & ViewData
  3. 🛠️ Form Structure & Fields
  4. 🚨 Error Handling & Partial Views
  5. 💻 Scripts & Dependencies
  6. 📊 UML Diagrams
  7. 📦 Usage Example
  8. ✅ Conclusion

🚀 Overview & Purpose

This Razor View renders a Create Dock form that allows end-users to enter details about a new docking station (or similar asset) into the IrbyImaging system. It:

  • Presents dropdowns for selecting Model, Owner, and Status.
  • Accepts free-text for Serial Number and Notes.
  • Validates inputs and posts the form back to the DocksController.Create action (HTTP POST).
  • Displays any server-side error via a modal partial.

⚙️ Layout & ViewData

@model DockCreateViewModel
@{
    ViewData["Title"]  = "Create";
    Layout             = "~/Views/Shared/_ATSLayout.cshtml";
}
  • @model
    Binds the view to DockCreateViewModel, which encapsulates:

    • SelectList properties: ModelList, OwnerList
    • Form fields: ModelId, SerialNumber, PurchaseDate, OwnerId, Status, Notes
    • Error messaging: ErrorMessage
  • ViewData["Title"]
    Sets the HTML <title> and a header of "Create" in the layout.

  • Layout
    Inherits from _ATSLayout.cshtml, ensuring consistent header, footer, and navigation.


🛠️ Form Structure & Fields

<h2>New Dock</h2>
<hr />

<div class="row">
  <div class="col-md-4">
    <form asp-action="Create">
      <!-- Validation Summary -->
      <div asp-validation-summary="ModelOnly" class="text-danger"></div>

      <!-- Form Fields -->
      ...
      <!-- Buttons -->
      <div class="form-group">
        <a asp-action="Index" class="btn btn-danger irby-red">Index List</a>
        <input type="submit" value="Create" class="btn btn-success irby-green" />
      </div>
    </form>
  </div>
</div>

3.1 Validation Summary

<div asp-validation-summary="ModelOnly" class="text-danger"></div>
  • asp-validation-summary="ModelOnly"
    Lists all model-level errors (e.g., ModelState.AddModelError entries).
  • Styled with .text-danger to show in red.

3.2 Detailed Field Breakdown

Field HTML Helper Type / Control Validation Message
Model <select asp-for="ModelId"> Dropdown (SelectList) –
Serial Number <input asp-for="SerialNumber" /> Textbox <span asp-validation-for="SerialNumber">
Purchase Date <input asp-for="PurchaseDate" /> Date Picker/Text <span asp-validation-for="PurchaseDate">
Owner <select asp-for="OwnerId"> Dropdown (SelectList) <span asp-validation-for="OwnerId">
Status <select asp-for="Status"> Dropdown (Enum) <span asp-validation-for="Status">
Notes <textarea asp-for="Notes"> Textarea <span asp-validation-for="Notes">

Example Snippet: Status Dropdown

<div class="form-group">
  <label asp-for="Status" class="control-label"></label>
  <select asp-for="Status" class="form-control"
          asp-items="@(Html
                        .GetEnumSelectList<IrbyImaging.Utility.AssetStatus>()
                        .Where(e => e.Text != "All"))">
  </select>
  <span asp-validation-for="Status" class="text-danger"></span>
</div>
  • Html.GetEnumSelectList<AssetStatus>() generates <option> for each enum value.
  • .Where(e => e.Text != "All") filters out a catch-all option.

🚨 Error Handling & Partial Views

@if (!string.IsNullOrEmpty(Model.ErrorMessage))
{
    await Html.RenderPartialAsync("_ErrorModalPartial");
}
  • Model.ErrorMessage
    When non-empty, triggers rendering of _ErrorModalPartial.cshtml.
  • _ErrorModalPartial
    Typically shows a Bootstrap modal with the error message for improved UX.

Validation scripts and error modal scripts are injected in the @section Scripts:

@section Scripts {
  @{ await Html.RenderPartialAsync("_ValidationScriptsPartial"); }
  @{ await Html.RenderPartialAsync("_ErrorModalScriptsPartial"); }
}

💻 Scripts & Dependencies

Below the form, the view loads several JavaScript libraries required by the layout and UI components:

Library Path Purpose
Bootstrap ~/libs/bootstrap/js/bootstrap.bundle.min.js Modal, form styling, grid
MetisMenu ~/libs/metismenu/metisMenu.min.js Sidebar menu interactions
SimpleBar ~/libs/simplebar/simplebar.min.js Custom scrollbars
Waves ~/libs/node-waves/waves.min.js Click wave effects
Validation Scripts _ValidationScriptsPartial.cshtml jQuery Validation & Unobtrusive
Error Modal Scripts _ErrorModalScriptsPartial.cshtml JS to trigger the error modal

📊 UML Diagrams

1. Sequence Diagram

sequenceDiagram
    participant User
    participant Browser
    participant Server
    participant Controller as DocksController
    participant ViewModel as DockCreateViewModel
    participant View as Create.cshtml

    User->>Browser: Navigate to /Docks/Create (GET)
    Browser->>Server: HTTP GET /Docks/Create
    Server->>Controller: DocksController.Create()
    Controller->>ViewModel: Populate ModelList, OwnerList, default Status
    Controller->>View: Return View(viewModel)
    Browser->>View: Render HTML form

    User->>Browser: Fill & Submit form (POST)
    Browser->>Server: HTTP POST /Docks/Create {form data}
    Server->>Controller: Validate DockCreateViewModel
    alt ModelState Valid
        Controller->>Database: Insert new Dock
        Controller-->>Browser: RedirectToAction("Index")
    else ModelState Invalid
        Controller-->>View: Return View(viewModel)
        Browser->>View: Show validation errors
    end

2. Class Diagram: DockCreateViewModel

classDiagram
class DockCreateViewModel {
    + int ModelId
    + string SerialNumber
    + DateTime PurchaseDate
    + int OwnerId
    + AssetStatus Status
    + string Notes
    + SelectList ModelList
    + SelectList OwnerList
    + string ErrorMessage
}
class AssetStatus {
    <<enumeration>>
    Available
    InUse
    Maintenance
    Retired
}
DockCreateViewModel ..> SelectList : uses
DockCreateViewModel ..> AssetStatus : uses

📦 Usage Example

1. Controller Snippet

public class DocksController : Controller
{
    private readonly IRepository<Dock> _dockRepo;
    private readonly IRepository<Model> _modelRepo;
    private readonly IRepository<Owner> _ownerRepo;

    public IActionResult Create()
    {
        var vm = new DockCreateViewModel
        {
            ModelList = new SelectList(_modelRepo.GetAll(), "Id", "Name"),
            OwnerList = new SelectList(_ownerRepo.GetAll(), "Id", "FullName")
        };
        return View(vm);
    }

    [HttpPost]
    public IActionResult Create(DockCreateViewModel vm)
    {
        if (!ModelState.IsValid)
            return View(vm);

        var dock = new Dock {
           ModelId      = vm.ModelId,
           SerialNumber = vm.SerialNumber,
           PurchaseDate = vm.PurchaseDate,
           OwnerId      = vm.OwnerId,
           Status       = vm.Status,
           Notes        = vm.Notes
        };

        _dockRepo.Add(dock);
        return RedirectToAction(nameof(Index));
    }
}

2. Invoking the View

  • URL: /Docks/Create
  • Method:
    • GET → Shows form
    • POST → Accepts form data

Upon successful POST, user is redirected to Index (list of docks).


✅ Conclusion

This Create.cshtml view provides a user-friendly interface for capturing new Dock assets. It leverages:

  • Razor HTML Helpers for strongly-typed data-binding
  • ASP.NET Core Tag Helpers (asp-for, asp-items, asp-action)
  • Client & Server-side Validation
  • Partial Views for error/modal and validation scripts
  • Responsive Layout via Bootstrap

By following the patterns above, you ensure:

  • Consistency across forms
  • Strong typing with ViewModels
  • Clean separation of concerns (View vs. Controller vs. Model)

Feel free to extend this view with custom styling or additional fields as your application grows! 🚀