Merge pull request #479 from SyncfusionExamples/991257-field

991257 - How to Work with Fields in Word Documents Using the .NET Word Library

Author: MathanKumarVaradhaRajaPerumal

Videos/Fields/Controllers/HomeController.cs

@@ -0,0 +1,104 @@
+using System.Diagnostics;
+using Fields.Models;
+using Microsoft.AspNetCore.Mvc;
+using Syncfusion.DocIO;
+using Syncfusion.DocIO.DLS;
+
+namespace Fields.Controllers
+{
+    public class HomeController : Controller
+    {
+        private readonly ILogger<HomeController> _logger;
+
+        public HomeController(ILogger<HomeController> logger)
+        {
+            _logger = logger;
+        }
+
+        public IActionResult AddField()
+        {
+            using (FileStream fileStream = new FileStream("Data\\Template.docx", FileMode.Open, FileAccess.Read))
+            {
+                WordDocument document = new WordDocument(fileStream, FormatType.Automatic);
+
+                foreach (WSection section in document.Sections)
+                {
+                    WParagraph footerParagraph = (WParagraph)section.HeadersFooters.Footer.AddParagraph();
+
+                    footerParagraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
+
+                    footerParagraph.AppendText("Page ");
+                    footerParagraph.AppendField("Page", FieldType.FieldPage);
+
+                    footerParagraph.AppendText(" of ");
+                    footerParagraph.AppendField("NumPages", FieldType.FieldNumPages);
+                }
+
+                return CreateFileResult(document, "AddField.docx");
+            }
+        }
+
+        public IActionResult UpdateField()
+        {
+            using (FileStream fileStream = new FileStream("Data\\Input.docx", FileMode.Open, FileAccess.Read))
+            {
+                WordDocument document = new WordDocument(fileStream, FormatType.Automatic);
+
+                document.UpdateDocumentFields();
+
+                return CreateFileResult(document, "UpdateField.docx");
+            }
+        }
+
+        public IActionResult UnlinkField()
+        {
+            using (FileStream fileStream = new FileStream("Data\\InputTemplate.docx", FileMode.Open, FileAccess.Read))
+            {
+                WordDocument document = new WordDocument(fileStream, FormatType.Automatic);
+
+                foreach (WSection section in document.Sections)
+                {
+                    foreach (WParagraph paragraph in section.Body.Paragraphs)
+                    {
+                        for (int i = 0; i < paragraph.Items.Count; i++)
+                        {
+                            if (paragraph.Items[i] is WField field)
+                            {
+                                if (field.FieldType == FieldType.FieldDate)
+                                {
+                                    field.Unlink();
+                                }
+                            }
+                        }
+                    }
+                }
+
+                return CreateFileResult(document, "UnlinkField.docx");
+            }
+        }
+
+        private FileStreamResult CreateFileResult(WordDocument document, string fileName)
+        {
+            MemoryStream outputStream = new MemoryStream();
+            document.Save(outputStream, FormatType.Docx);
+            outputStream.Position = 0;
+            return File(outputStream, "application/docx", 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/Fields/Data/Input.docx

@@ -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.DocIO.Net.Core" Version="31.1.22" />
+  </ItemGroup>
+
+</Project>

Videos/Fields/Data/InputTemplate.docx

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

Videos/Fields/Data/Template.docx

@@ -0,0 +1,36 @@
+namespace Fields
+{
+    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/Fields/Fields.csproj

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

Videos/Fields/Models/ErrorViewModel.cs

@@ -0,0 +1,21 @@
+# How to Work with Fields in Word Documents Using the .NET Word Library
+
+This repository provides an example of how to work with fields in a Word document using the **Syncfusion .NET Word Library (DocIO)**. It demonstrates how to add field, update field, and unlink field in a Word document.
+
+## Process behind Field Integration
+
+This sample demonstrates how Word fields can be used to automate dynamic content in documents. Fields act as placeholders that display information such as page numbers, total pages, or dates, and they update automatically when the document changes.
+
+Using the Syncfusion DocIO library, you can:
+
+- Add fields like page numbers into headers or footers for consistent formatting.
+- Update fields to refresh their values after edits or content changes.
+- Unlink fields to convert them into static text when you no longer need dynamic updates.
+
+## Steps to use the sample
+
+1. Open the ASP.NET Core application where the Syncfusion DocIO package is installed.
+2. Run the application and click the following buttons:
+   - **AddField**: Creates a Word document with page number fields.
+   - **UpdateField**: Updates all fields in the document.
+   - **UnlinkField**: Converts date fields to static text.

Videos/Fields/Program.cs

@@ -0,0 +1,21 @@
+@{
+    ViewData["Title"] = "Home Page";
+}
+
+<div>
+    <h2 style="margin-bottom: 20px; font-size: 22px;">Working with Fields in Word Document</h2>
+    <div>
+        <button style="width: 180px; margin-bottom: 20px; height: 40px; display: block; font-size: 18px;"
+                onclick="location.href='@Url.Action("AddField", "Home")'">
+            Add Field
+        </button>
+        <button style="width: 180px; margin-bottom: 20px; height: 40px; display: block; font-size: 18px;"
+                onclick="location.href='@Url.Action("UpdateField", "Home")'">
+            Update Field
+        </button>
+        <button style="width: 180px; margin-bottom: 20px; height: 40px; display: block; font-size: 18px;"
+                onclick="location.href='@Url.Action("UnlinkField", "Home")'">
+            Unlink Field
+        </button>
+    </div>
+</div>