๐Ÿ“„ balancesModal.cshtml Documentation


๐Ÿ“‘ Table of Contents

  1. Overview & Purpose
  2. Dependencies & Technologies
  3. Model & ViewModel
  4. Layout & Regions
  5. Data Rendering with DataTables
  6. Scripts & Initialization
  7. CSS & Styling
  8. Thirdโ€‘Party Integrations
  9. Usage Example
  10. UML Sequence Diagram
  11. Conclusion

๐Ÿ” Overview & Purpose

balancesModal.cshtml is a Razor view in the IrbyImaging ASP.NET MVC application.
It renders a modal-like region displaying a tabular breakdown of job balances (i.e., revenue by job number, cost code, etc.) using the jQuery DataTables plugin.

Key Goals

  • Present a responsive, exportable, and interactive grid of data.
  • Provide export capabilities: CSV, Excel, Print.
  • Keep the UI lightโ€”ditch commented-out Syncfusion TreeGrid code in favor of DataTables.

๐Ÿ›  Dependencies & Technologies

Category Library / Framework Purpose
Server-side ASP.NET MVC Rendering Razor views, model binding
View Model IrbyImaging.UI.Models.Balances Supplies Details collection
CSS DataTables Bootstrap 4, DataTables Responsive Table styling & responsiveness
JavaScript Plugins jQuery, DataTables, Buttons, JSZip, pdfmake Data rendering & exporting
CDN URLs Various (see Scripts section) Remote delivery of DataTables, Buttons, etc.

๐Ÿ“ฆ Model & ViewModel

@model IrbyImaging.UI.Models.Balances

Balances ViewModel

  • Details: IEnumerable<BalanceDetail>
    • JobNumber (string)
    • JobName (string)
    • CostCode (string)
    • CostCodeDescription (string)
    • Revenue (decimal)

This model is passed from the controller to populate each row of the HTML table.


๐Ÿงฉ Layout & Regions

<div class="row">
  <div id="ControlRegion">
    <!-- DataTables HTML Table goes here -->
  </div>
</div>
  • .row: Bootstrap row wrapper.
  • #ControlRegion: Container for the DataTable.

Note: A Syncfusion TreeGrid block is commented outโ€”indicating a prior or alternate implementation.


๐Ÿ“Š Data Rendering with DataTables

HTML Table Structure

<table id="jobDatatable"
       class="table table-striped table-bordered dt-responsive nowrap cell-border"
       width="100%" cellspacing="0">
  <thead>
    <tr>
      <th>Job Number</th>
      <th>Job Name</th>
      <th>Cost Code</th>
      <th>Description</th>
      <th>Revenue</th>
    </tr>
  </thead>
  <tbody>
    @foreach (var item in Model.Details) {
      <tr>
        <td>@Html.DisplayFor(m => item.JobNumber)</td>
        <td>@Html.DisplayFor(m => item.JobName)</td>
        <td>@Html.DisplayFor(m => item.CostCode)</td>
        <td>@Html.DisplayFor(m => item.CostCodeDescription)</td>
        <td>@Html.DisplayFor(m => item.Revenue)</td>
      </tr>
    }
  </tbody>
</table>

Features

  • Responsive layout (dt-responsive nowrap).
  • Striped rows and borders (.table-striped .table-bordered).
  • Cell-border class to accentuate cells.

โš™๏ธ Scripts & Initialization

Included Script References

<script src="https://cdn.datatables.net/1.10.25/js/jquery.dataTables.min.js"></script>
<script src="https://cdn.datatables.net/buttons/1.7.1/js/dataTables.buttons.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.3/jszip.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.53/pdfmake.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.53/vfs_fonts.js"></script>
<script src="https://cdn.datatables.net/buttons/1.7.1/js/buttons.html5.min.js"></script>
<script src="https://cdn.datatables.net/buttons/1.7.1/js/buttons.print.min.js"></script>

Initialization Logic

<script type="text/javascript">
  $(document).ready(function () {
    $('#jobDatatable').DataTable({
      dom: 'Bfrtip',
      buttons: [
        'csv', 'excel', 'print'
      ]
    });
  });
</script>
  • dom: 'Bfrtip':

    • B โ€“ Buttons
    • f โ€“ Filtering input
    • r โ€“ Processing display element
    • t โ€“ Table
    • i โ€“ Table information summary
    • p โ€“ Pagination
  • Buttons:

    • csv: Export as .csv
    • excel: Export as .xlsx
    • print: Print-friendly view

๐ŸŽจ CSS & Styling

<link href="~/lib/datatables/css/dataTables.bootstrap4.min.css" rel="stylesheet" />
<link href="https://cdn.datatables.net/1.10.25/css/jquery.dataTables.min.css" rel="stylesheet" />
<link href="https://cdn.datatables.net/buttons/1.7.1/css/buttons.dataTables.min.css" rel="stylesheet" />

<style>
  #jobDatatable {
    display: table-header-group; /* Keep header fixed when printing */
  }
</style>
  • Bootstrap4 and DataTables styles for consistent theming.
  • Inline style to ensure header grouping during print/export.

๐Ÿ”— Thirdโ€‘Party Integrations

Library Purpose
jQuery (v3.5.1+) DOM manipulation, event handling
DataTables (+ Buttons) Data grid with export & interactivity
JSZip Excel export functionality
pdfmake PDF export generation

๐Ÿงช Usage Example

Controller Action:

public ActionResult BalancesModal()
{
    var model = new Balances
    {
        Details = _balanceService.GetJobBalances() // IEnumerable<BalanceDetail>
    };
    return PartialView("balancesModal", model);
}

Render in Parent View (e.g., within a Bootstrap modal):

<div class="modal fade" id="balancesModal" tabindex="-1" role="dialog">
  <div class="modal-dialog modal-lg" role="document">
    <div class="modal-content">
      @Html.Partial("IView/balancesModal", Model.Balances)
    </div>
  </div>
</div>

๐Ÿ“ˆ UML Sequence Diagram

@startuml
actor User
participant Browser
participant MVC_Controller as Controller
participant Razor_View as View
participant DataService

User -> Browser: Click "View Balances"
Browser -> Controller: GET /BalancesModal
Controller -> DataService: GetJobBalances()
DataService --> Controller: IEnumerable<BalanceDetail>
Controller -> View: Render balancesModal.cshtml(Model)
View -> Browser: HTML + JS + CSS
Browser -> DataTables: initialize()
@enduml

Sequence Diagram


๐Ÿ Conclusion

balancesModal.cshtml provides a lightweight, interactive, and exportable data grid for viewing job balances. By leveraging jQuery DataTables and its Buttons extension, it delivers an excellent UX with minimal custom code. The Razor view cleanly separates concerns:

  • Model Binding: Uses Balances ViewModel
  • HTML: Table markup
  • CSS & JS: CDN-based includes & initialization

This modular approach makes it easy to embed within any modal or page for quick balance reporting.

๐ŸŽ‰ Youโ€™re all set to integrate, customize columns, and extend filtering or grouping as your project grows!