993776 - How to Work with Comments in an Excel Document Using the .NET Excel Library

Videos/Comments/Comments.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Syncfusion.XlsIO.Net.Core" Version="31.2.5" />
+  </ItemGroup>
+
+</Project>

Videos/Comments/Controllers/HomeController.cs

@@ -0,0 +1,160 @@
+using System.Diagnostics;
+using Comments.Models;
+using Microsoft.AspNetCore.Mvc;
+using Syncfusion.XlsIO;
+
+namespace Comments.Controllers
+{
+    public class HomeController : Controller
+    {
+        private readonly ILogger<HomeController> _logger;
+
+        public HomeController(ILogger<HomeController> logger)
+        {
+            _logger = logger;
+        }
+
+        public IActionResult AddComment()
+        {
+            // Initialize the Excel engine
+            ExcelEngine excelEngine = new ExcelEngine();
+            IApplication application = excelEngine.Excel;
+            application.DefaultVersion = ExcelVersion.Xlsx;
+
+            // Open the Excel workbook from the specified template
+            IWorkbook workbook = application.Workbooks.Open("Data\\CommentsTemplate.xlsx", ExcelOpenType.Automatic);
+            IWorksheet worksheet = workbook.Worksheets[0];
+
+            // Add a threaded comment to cell H16
+            IThreadedComment threadedComment = worksheet.Range["H16"].AddThreadedComment(
+                "What is the reason for the higher total amount of \"desk\" in the west region?",
+                "User1",
+                DateTime.Now
+            );
+
+            // Export the modified workbook as a downloadable Excel file
+            return ExportWorkbook(workbook, "AddComment.xlsx");
+        }
+
+        public IActionResult ReplyComment()
+        {
+            // Initialize the Excel engine
+            ExcelEngine excelEngine = new ExcelEngine();
+            IApplication application = excelEngine.Excel;
+            application.DefaultVersion = ExcelVersion.Xlsx;
+
+            // Open the workbook containing the comment to reply to
+            IWorkbook workbook = application.Workbooks.Open("Data\\ReplyInput.xlsx", ExcelOpenType.Automatic);
+            IWorksheet worksheet = workbook.Worksheets[0];
+
+            // Access the collection of threaded comments
+            IThreadedComments threadedComments = worksheet.ThreadedComments;
+
+            // Add a reply to the first threaded comment
+            threadedComments[0].AddReply(
+                "The unit cost of desk is higher compared to other items in the west region. As a result, the total amount is elevated.",
+                "User2",
+                DateTime.Now
+            );
+
+            // Export the modified workbook
+            return ExportWorkbook(workbook, "ReplyComment.xlsx");
+        }
+
+        public IActionResult ResolveComment()
+        {
+            // Initialize the Excel engine
+            ExcelEngine excelEngine = new ExcelEngine();
+            IApplication application = excelEngine.Excel;
+            application.DefaultVersion = ExcelVersion.Xlsx;
+
+            // Open the workbook containing the comment to resolve
+            IWorkbook workbook = application.Workbooks.Open("Data\\ResolveInput.xlsx", ExcelOpenType.Automatic);
+            IWorksheet worksheet = workbook.Worksheets[0];
+
+            // Access the threaded comments
+            IThreadedComments threadedComments = worksheet.ThreadedComments;
+
+            // Mark the first comment as resolved
+            threadedComments[0].IsResolved = true;
+
+            // Export the updated workbook
+            return ExportWorkbook(workbook, "ResolveComment.xlsx");
+        }
+
+        public IActionResult DeleteComment()
+        {
+            // Initialize the Excel engine
+            ExcelEngine excelEngine = new ExcelEngine();
+            IApplication application = excelEngine.Excel;
+            application.DefaultVersion = ExcelVersion.Xlsx;
+
+            // Open the workbook containing the comment to delete
+            IWorkbook workbook = application.Workbooks.Open("Data\\DeleteInput.xlsx", ExcelOpenType.Automatic);
+            IWorksheet worksheet = workbook.Worksheets[0];
+
+            // Access the threaded comments
+            IThreadedComments threadedComments = worksheet.ThreadedComments;
+
+            // Delete the first threaded comment
+            threadedComments[0].Delete();
+
+            // Export the updated workbook
+            return ExportWorkbook(workbook, "DeleteComment.xlsx");
+        }
+
+        public IActionResult ClearComment()
+        {
+            // Initialize the Excel engine
+            ExcelEngine excelEngine = new ExcelEngine();
+            IApplication application = excelEngine.Excel;
+            application.DefaultVersion = ExcelVersion.Xlsx;
+
+            // Open the workbook containing comments to clear
+            IWorkbook workbook = application.Workbooks.Open("Data\\ClearInput.xlsx", ExcelOpenType.Automatic);
+            IWorksheet worksheet = workbook.Worksheets[0];
+
+            // Access all threaded comments
+            IThreadedComments threadedComments = worksheet.ThreadedComments;
+
+            // Clear all threaded comments from the worksheet
+            threadedComments.Clear();
+
+            // Export the cleaned workbook
+            return ExportWorkbook(workbook, "ClearComment.xlsx");
+        }
+
+        private FileStreamResult ExportWorkbook(IWorkbook workbook, string fileName)
+        {
+
+            // Create a memory stream to hold the Excel file content
+            MemoryStream stream = new MemoryStream();
+
+            // Save the workbook to the memory stream
+            workbook.SaveAs(stream);
+
+            // Reset the stream position to the beginning
+            stream.Position = 0;
+
+            // Return the stream as a downloadable Excel file with the specified filename
+            return File(stream, "application/xlsx", fileName);
+
+        }
+
+        public IActionResult Index()
+        {
+            return View();
+        }
+
+        public IActionResult Privacy()
+        {
+            return View();
+        }
+
+        [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
+        public IActionResult Error()
+        {
+            return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
+        }
+    }
+}

Videos/Comments/Models/ErrorViewModel.cs

@@ -0,0 +1,9 @@
+namespace Comments.Models
+{
+    public class ErrorViewModel
+    {
+        public string? RequestId { get; set; }
+
+        public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
+    }
+}

Videos/Comments/Program.cs

@@ -0,0 +1,36 @@
+namespace Comments
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            var builder = WebApplication.CreateBuilder(args);
+
+            // Add services to the container.
+            builder.Services.AddControllersWithViews();
+
+            var app = builder.Build();
+
+            // Configure the HTTP request pipeline.
+            if (!app.Environment.IsDevelopment())
+            {
+                app.UseExceptionHandler("/Home/Error");
+                // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
+                app.UseHsts();
+            }
+
+            app.UseHttpsRedirection();
+            app.UseStaticFiles();
+
+            app.UseRouting();
+
+            app.UseAuthorization();
+
+            app.MapControllerRoute(
+                name: "default",
+                pattern: "{controller=Home}/{action=Index}/{id?}");
+
+            app.Run();
+        }
+    }
+}

Videos/Comments/Properties/launchSettings.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:48728",
+      "sslPort": 44343
+    }
+  },
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "http://localhost:5072",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "applicationUrl": "https://localhost:7280;http://localhost:5072",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

Videos/Comments/Views/Home/Index.cshtml

@@ -0,0 +1,29 @@
+@{
+    ViewData["Title"] = "Home Page";
+}
+
+<div>
+    <h2 style="margin-bottom: 20px"> Working with Comments in Excel</h2>
+    <div>
+        <button style="width: 200px; margin-bottom: 20px; height: 40px;display:block;font-size:18px;"
+                onclick="location.href='@Url.Action("AddComment", "Home")'">
+            Add Comment
+        </button>
+        <button style="width: 200px; margin-bottom: 20px; height: 40px;display:block;font-size:18px;"
+                onclick="location.href='@Url.Action("ReplyComment", "Home")'">
+            Reply Comment
+        </button>
+        <button style="width: 200px; margin-bottom: 20px; height: 40px;display:block;font-size:18px;"
+                onclick="location.href='@Url.Action("ResolveComment", "Home")'">
+            Resolve Comment
+        </button>
+        <button style="width: 200px; margin-bottom: 20px; height: 40px;display:block;font-size:18px;"
+                onclick="location.href='@Url.Action("DeleteComment", "Home")'">
+            Delete Comment
+        </button>
+        <button style="width: 200px; margin-bottom: 20px; height: 40px;display:block;font-size:18px;"
+                onclick="location.href='@Url.Action("ClearComment", "Home")'">
+            Clear Comment
+        </button>
+    </div>
+</div>

Videos/Comments/Views/Home/Privacy.cshtml

@@ -0,0 +1,6 @@
+@{
+    ViewData["Title"] = "Privacy Policy";
+}
+<h1>@ViewData["Title"]</h1>
+
+<p>Use this page to detail your site's privacy policy.</p>

Videos/Comments/Views/Shared/Error.cshtml

@@ -0,0 +1,25 @@
+@model ErrorViewModel
+@{
+    ViewData["Title"] = "Error";
+}
+
+<h1 class="text-danger">Error.</h1>
+<h2 class="text-danger">An error occurred while processing your request.</h2>
+
+@if (Model.ShowRequestId)
+{
+    <p>
+        <strong>Request ID:</strong> <code>@Model.RequestId</code>
+    </p>
+}
+
+<h3>Development Mode</h3>
+<p>
+    Swapping to <strong>Development</strong> environment will display more detailed information about the error that occurred.
+</p>
+<p>
+    <strong>The Development environment shouldn't be enabled for deployed applications.</strong>
+    It can result in displaying sensitive information from exceptions to end users.
+    For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
+    and restarting the app.
+</p>

Videos/Comments/Views/Shared/_Layout.cshtml

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>@ViewData["Title"] - Comments</title>
+    <link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
+    <link rel="stylesheet" href="~/css/site.css" asp-append-version="true" />
+    <link rel="stylesheet" href="~/Comments.styles.css" asp-append-version="true" />
+</head>
+<body>
+    <header>
+        <nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
+            <div class="container-fluid">
+                <a class="navbar-brand" asp-area="" asp-controller="Home" asp-action="Index">Comments</a>
+                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target=".navbar-collapse" aria-controls="navbarSupportedContent"
+                        aria-expanded="false" aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+                <div class="navbar-collapse collapse d-sm-inline-flex justify-content-between">
+                    <ul class="navbar-nav flex-grow-1">
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Index">Home</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+        </nav>
+    </header>
+    <div class="container">
+        <main role="main" class="pb-3">
+            @RenderBody()
+        </main>
+    </div>
+
+    <footer class="border-top footer text-muted">
+        <div class="container">
+            &copy; 2025 - Comments - <a asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
+        </div>
+    </footer>
+    <script src="~/lib/jquery/dist/jquery.min.js"></script>
+    <script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
+    <script src="~/js/site.js" asp-append-version="true"></script>
+    @await RenderSectionAsync("Scripts", required: false)
+</body>
+</html>