Add Side-by-Side-Comparison sample for ASP.NET Core DOCX Editor

New sample comparing original and revised Word documents using Syncfusion DocIO with side-by-side Document Editors, tracked revisions view, and download of the compared document.

Co-authored-by: suriyaprakasamr <302142999+suriyaprakasamr@users.noreply.github.com>

Author: Bold Create Agent

.gitignore

@@ -0,0 +1,46 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# Build results
+[Dd]ebug/
+[Rr]elease/
+x64/
+x86/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# .NET build artifacts
+*.dll
+*.exe
+*.pdb
+*.cache
+
+# Visual Studio / Rider / VS Code metadata
+.vs/
+.vscode/
+.idea/
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# NuGet
+*.nupkg
+packages/
+**/packages/*
+!**/packages/build/
+
+# Node
+node_modules/
+package-lock.json
+npm-debug.log*
+yarn-error.log*
+
+# Publish output
+[Pp]ublishOutput/
+publish/
+
+# Runtime data
+*.log

Side-by-Side-Comparison/Controllers/DocumentEditorController.cs

@@ -0,0 +1,97 @@
+using Microsoft.AspNetCore.Mvc;
+using Newtonsoft.Json;
+using WDocument = Syncfusion.DocIO.DLS.WordDocument;
+using WFormatType = Syncfusion.DocIO.FormatType;
+
+namespace DocumentEditor.Controllers
+{
+    [ApiController]
+    [Route("api/[controller]")]
+    public class DocumentEditorController : Controller
+    {
+        /// <summary>
+        /// Imports a DOCX file and returns its SFDT (Syncfusion Document Text) JSON content.
+        /// </summary>
+        [Route("Import")]
+        public string Import(IFormCollection data)
+        {
+            if (data.Files.Count == 0)
+            {
+                return string.Empty;
+            }
+
+            IFormFile file = data.Files[0];
+            int index = file.FileName.LastIndexOf('.');
+            string extension = index > -1 && index < file.FileName.Length - 1 ?
+                file.FileName.Substring(index) : ".docx";
+
+            if (extension == ".sfdt")
+            {
+                using (var streamReader = new StreamReader(file.OpenReadStream()))
+                {
+                    return streamReader.ReadToEnd();
+                }
+            }
+
+            Stream stream = new MemoryStream();
+            file.CopyTo(stream);
+            stream.Position = 0;
+
+            // Convert the DOCX stream to SFDT DOM.
+            Syncfusion.EJ2.DocumentEditor.WordDocument document = Syncfusion.EJ2.DocumentEditor.WordDocument.Load(stream, Syncfusion.EJ2.DocumentEditor.FormatType.Docx);
+            string json = JsonConvert.SerializeObject(document);
+            document.Dispose();
+            return json;
+        }
+
+        /// <summary>
+        /// Compares an original and a revised DOCX document and returns the compared document as SFDT content with tracked changes.
+        /// </summary>
+        [Route("CompareDocuments")]
+        public string CompareDocuments(IFormCollection data)
+        {
+            if (data.Files.Count < 2)
+            {
+                return string.Empty;
+            }
+
+            IFormFile? originalFile = data.Files.FirstOrDefault(f => f.Name == "originalFile");
+            IFormFile? revisedFile = data.Files.FirstOrDefault(f => f.Name == "revisedFile");
+            if (originalFile == null || revisedFile == null)
+            {
+                return string.Empty;
+            }
+
+            string author = data.TryGetValue("author", out var authorValue) ? authorValue.ToString() : "Author";
+            string dateTime = data.TryGetValue("dateTime", out var dateValue) ? dateValue.ToString() : DateTime.UtcNow.ToString("o");
+
+            var originalStream = new MemoryStream();
+            originalFile.CopyTo(originalStream);
+            originalStream.Position = 0;
+
+            var revisedStream = new MemoryStream();
+            revisedFile.CopyTo(revisedStream);
+            revisedStream.Position = 0;
+
+            // Load the original and revised documents using the Syncfusion .NET Word (DocIO) library.
+            WDocument originalDocument = new WDocument();
+            originalDocument.Settings.SkipIncrementalSaveValidation = true;
+            originalDocument.Open(originalStream, WFormatType.Automatic);
+
+            WDocument revisedDocument = new WDocument();
+            revisedDocument.Settings.SkipIncrementalSaveValidation = true;
+            revisedDocument.Open(revisedStream, WFormatType.Automatic);
+
+            // Compare the revised document against the original document.
+            originalDocument.Compare(revisedDocument, author, Convert.ToDateTime(dateTime));
+
+            // Convert the compared Word document to SFDT content.
+            Syncfusion.EJ2.DocumentEditor.WordDocument document = Syncfusion.EJ2.DocumentEditor.WordDocument.Load(originalDocument);
+            string json = JsonConvert.SerializeObject(document);
+            document.Dispose();
+            originalDocument.Dispose();
+            revisedDocument.Dispose();
+            return json;
+        }
+    }
+}

Side-by-Side-Comparison/DocumentEditor.csproj

@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Syncfusion.DocIO.Net.Core" Version="35.1.40" />
+    <PackageReference Include="Syncfusion.EJ2.AspNet.Core" Version="35.1.40" />
+    <PackageReference Include="Syncfusion.EJ2.WordEditor.AspNet.Core" Version="35.1.40" />
+    <PackageReference Include="Syncfusion.Licensing" Version="35.1.40" />
+  </ItemGroup>
+
+</Project>

Side-by-Side-Comparison/Pages/Error.cshtml

@@ -0,0 +1,26 @@
+@page
+@model ErrorModel
+@{
+    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 the <strong>Development</strong> environment displays 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>

Side-by-Side-Comparison/Pages/Error.cshtml.cs

@@ -0,0 +1,21 @@
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+using System.Diagnostics;
+
+namespace DocumentEditor.Pages
+{
+    [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
+    [IgnoreAntiforgeryToken]
+    public class ErrorModel : PageModel
+    {
+        public string? RequestId { get; set; }
+
+        public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
+
+        public void OnGet()
+        {
+            RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier;
+        }
+    }
+
+}