📄 GetDocumentCategories.cshtml Documentation
Path:
IrbyImaging/Views/HRImaging/GetDocumentCategories.cshtml
Type: ASP.NET Core Razor View
Purpose: Display and manage HR Document Categories/Types in an interactive grid with sorting, grouping, filtering, paging, Excel export and search capabilities.
📑 Table of Contents
- Overview & Purpose
- Dependencies & Technologies
- Data Model & ViewModel
- Layout & ViewData Configuration
- Custom Styles & Themes
- Grid Configuration & Columns
- Toolbar & Button Actions
- Client-Side Scripts & Event Handlers
- Usage Example
- Conclusion
1. 🔍 Overview & Purpose
This Razor View renders a Syncfusion EJ2 Grid to display and manage HR document categories and their associated types/indices. It offers administrators the ability to:
- 🔄 Sort, 🔎 Filter, 📑 Group and 🔢 Page through records
- 📤 Export the grid data to Excel
- 🔍 Search within the grid
- ➕ Add, ✏️ Edit, 🗑️ Delete records inline
- 🔀 Drag & drop rows
Intended Use:
The grid is bound to a data source (ViewBag.datasource) ofHRDocumentCategories. The controller action should populate this source and pass the model to the view.
2. 🛠️ Dependencies & Technologies
| Dependency | Purpose |
|---|---|
| ASP.NET Core MVC Razor | Server‐side view engine |
| Syncfusion.EJ2 | JavaScript UI controls (Grid, Button) |
| Syncfusion.JavaScript.Models | Grid/Filter/Query settings |
Bootstrap (via _Layout.cshtml) |
Responsive layout & styling |
@using Syncfusion.JavaScript
@using Syncfusion.JavaScript.Models
@using Syncfusion.EJ2
3. 🗃️ Data Model & ViewModel
ViewModel Binding
@model IrbyImaging.UI.Models.HRDocumentCategories
HRDocumentCategories (Sample)
public class HRDocumentCategories
{
public string DocumentCategory { get; set; }
public string DocumentType { get; set; }
public string IndexName { get; set; }
public bool MultiValueIndex { get; set; }
public string IndexValue { get; set; }
public string IndexType { get; set; }
}
- DocumentCategory: Grouping key (e.g., “Onboarding”).
- DocumentType: Sub‐category (e.g., “Form”).
- IndexName: Field used for indexing.
- MultiValueIndex: Flags if index allows multiple entries.
- IndexValue: Default or sample value.
- IndexType: Data type of the index (e.g., “String”, “Date”).
4. 🏗️ Layout & ViewData Configuration
@{
ViewData["Title"] = "List";
Layout = "~/Views/Shared/_Layout.cshtml";
}
- Title: Displays “List” in the browser title bar.
- Layout: Uses the shared
_Layout.cshtmlfor consistent header/footer.
5. 🎨 Custom Styles & Themes
A set of CSS rules to customize Syncfusion grid elements:
<style>
.e-grid .e-gridheader { border: 2px solid black; }
.e-grid .e-headercell { color: darkblue; }
.e-grid .e-sortnumber { background-color: #deecf9; font-family: cursive; }
.e-grid .e-groupcaption { background-color: #add8e6; font-style: italic; }
.e-grid .e-recordplusexpand { background-color: #5968bf; }
/* ... additional style overrides ... */
</style>
These styles give visual cues for sorting, grouping, and expanded rows.
6. 🗂️ Grid Configuration & Columns
<ejs-grid
id="Grid"
gridLines="Both"
allowSorting="true"
allowGrouping="true"
allowFiltering="true"
allowRowDragAndDrop="true"
allowPaging="true"
allowTextWrap="true"
dataSource="@ViewBag.datasource"
toolbar="@(new List<string>{ "ExcelExport", "Search" })"
allowExcelExport="true"
toolbarClick="toolbarClick"
>
<!-- Excel‐style Filtering -->
<e-grid-filterSettings type="Excel"></e-grid-filterSettings>
<!-- CRUD Operations -->
<e-grid-editSettings allowAdding="true" allowEditing="true" allowDeleting="true" edit-mode="@(EditMode.Normal)"></e-grid-editSettings>
<!-- Column Definitions -->
<e-grid-columns>
<e-grid-column field="DocumentCategory" headerText="Document Category" isPrimaryKey="true"></e-grid-column>
<e-grid-column field="DocumentType" headerText="Document Type" isPrimaryKey="true"></e-grid-column>
<e-grid-column field="IndexName" headerText="Index Name" isPrimaryKey="true"></e-grid-column>
<e-grid-column field="MultiValueIndex" headerText="Multi Value Index" textAlign="Center"></e-grid-column>
<e-grid-column field="IndexValue" headerText="Index Value"></e-grid-column>
<e-grid-column field="IndexType" headerText="Index Type" width="110"></e-grid-column>
</e-grid-columns>
</ejs-grid>
Key Features
- Excel‐style Filter:
type="Excel" - Inline Editing: Add/Edit/Delete directly in‐grid
- Grouping: Drag column headers to group
- Paging & Wrap:
allowPaging="true",allowTextWrap="true" - Data Binding: Binds to
ViewBag.datasource
7. 🔧 Toolbar & Button Actions
Clear Search Button
<ejs-button id="clear" content="Clear Search"></ejs-button>
- Clears the grid’s search box.
Toolbar Items
- ExcelExport: Export current grid data to
.xlsx. - Search: Displays a built‐in search box.
8. ⚡ Client-Side Scripts & Event Handlers
<script>
// Clear the search input
document.getElementById('clear').addEventListener('click', () => {
const gridObj = document.getElementById("Grid").ej2_instances[0];
gridObj.searchSettings.key = '';
});
// Handle toolbar button clicks
function toolbarClick(args) {
const gridObj = document.getElementById("Grid").ej2_instances[0];
if (args.item.id === 'Grid_excelexport') {
gridObj.excelExport(); // Trigger Excel export
}
}
</script>
- Event Hooks:
clearbutton → resets search keytoolbarClick→ listens for the Excel‐export toolbar item
9. 📦 Usage Example
Controller Action
public class HRImagingController : Controller
{
public IActionResult GetDocumentCategories()
{
// 1. Fetch data from your data layer / service
List<HRDocumentCategories> categories = _hrService.FetchCategories();
// 2. Pass to ViewBag for client‐side binding
ViewBag.datasource = categories;
// 3. Return the Razor view (model can be used for additional metadata)
return View(categories);
}
}
Rendering the View
@model List<IrbyImaging.UI.Models.HRDocumentCategories>
<!-- Renders the grid using GetDocumentCategories.cshtml -->
10. 🏁 Conclusion
This GetDocumentCategories.cshtml view empowers HR admins with a rich data‐grid interface for managing document categories and types. Leveraging Syncfusion EJ2, it delivers robust features out‐of‐the‐box:
- 🎯 Targeted Use: CRUD on HR document metadata
- 📊 Interactive UI: Sorting, grouping, filtering, paging
- 🗃️ Data Export: Excel support
- ⚙️ Extensibility: Easily extend columns, commands or integrate server‐side APIs
Next Steps:
- Implement server‐side validation on add/edit/delete.
- Secure endpoints for authorized users.
- Enhance with additional filters or detail templates.
Enjoy building a seamless HR document management experience! 🚀