Syncfusion Blazor DOCX Editor
Overview
Generates production-ready C# and Razor code for integrating the Syncfusion DOCX Editor (Document Editor) into Blazor Server or WebAssembly applications. It provides ready-to-use snippets and best practices for embedding a Document Editor that supports editing, reviewing, formatting, and more.
Key Capabilities
- Document Editing: Create, edit, and view Word documents.
- Protection: Apply read-only mode, allow comments, allow form filling, enforce tracked changes,and define editable ranges.
- Review: Enable track changes (revisions) and accept/reject changes.
- Comments: Add comments, replies, and author metadata.
- Find and replace: Perform programmatic find and replace operations for automation.
- Form Fields: Insert and fill text fields, check boxes, and dropdown form fields.
Prerequisites
Quick Start Examples
Example 1: Display a basic DOCX Editor
User: "Show me code to create a Document Editor component."
Result: C# + Razor code snippet displayed
Example 2: Enable Read‑Only Restriction Mode
User: "Create a Document Editor with Read‑Only restriction mode."
Result: A Blazor snippet that creates a Document Editor with read‑only protection enabled.
Generate C# Code for the User's Project (default)
Trigger keywords: "code", "snippet", "how to", "show me", "sample", "example code", "generate code", "implement", "add to component", "configure documenteditor", "create" , "blazor document editor", "docx editor", "document editor", "track changes", "load docx", "comments", "accept changes", "protect document", "find and replace", "content control"
Workflow:
Analyze the user's request to identify the feature (e.g., track changes, restrict editing, toolbar customization).
Read the relevant references/*.md file(s) to understand the APIs and code patterns for the requested feature.
STOP before generating code. Check if the user has already chosen a delivery mode.
If no delivery mode is chosen yet, you MUST ask the user first using this concise multiple-choice question:
"How would you like to receive the generated code?"
- Option 1: Replace the code in a specific project file (you'll need to provide the file path and confirm)
- Option 2: Share the code directly in the chat window
Only after the user selects a delivery mode, proceed to generate C# code using the APIs and snippets from references/*.md, substituting concrete placeholders from the user's project.
Do NOT make changes to workspace project files unless the user explicitly chose Option 1 and provided the file path with permission.
Provide complete C# snippets and concise integration steps after delivering the code.
Refer to ## Rules section for operational constraints (output directory, temporary files, allowed libraries, etc.)
Code References
All code snippets and examples are in the references/ folder. Each file contains:
- Minimal Code — a working, ready-to-use snippet
- Placeholders — values the user must customize
- Notes — best practices, additional information to note while using that functionality, constraints
| File |
Contents |
| getting-started.md |
Initialize Document Editor in Blazor WebAssembly |
| blazor-documenteditor-server.md |
Initialize Document Editor in Blazor Server |
| blazor-documenteditor-webapp.md |
Initialize Document Editor in Blazor Web App |
| form-fields.md |
Insert, edit, and manage form fields |
| comments.md |
Add, navigate, reply to, and manage comments |
| track-changes.md |
Enable track changes and review document revisions |
| document-protection.md |
Apply document protection and editing restrictions |
| spell-check.md |
Enable and configure spell checking |
| customize-toolbar.md |
Customize and control toolbar items |
| find-and-replace.md |
Find and replace text |
| paste-formatting.md |
Preserve clipboard formatting with paste support |
Key Rules for Code Generation
No inline code in SKILL.md — Always point to snippets in references/*.md. This file is loaded into context for every prompt; inline code wastes tokens.
Snippets must be tested — All code must compile and run against the current Syncfusion.Blazor.WordProcessor NuGet package version.
Minimal Code + Placeholders + Notes — Every reference file must include:
- Minimal Code (complete, working snippet)
- Placeholders (values user must substitute — marked with
{{ }} or [PLACEHOLDER])
- Notes (best practices, framework-specific adaptations, constraints)
Share code and notes for the requirement — Never create temporary files or scripts.
License handling — Never hardcode license keys. Point user to environment variables or config files.
Framework adaptation — Default to C# + Razor. When user specifies framework.
No hallucinated APIs — Use only verified Syncfusion DOCX Editor SDK method names. One wrong method breaks user trust.
Rules
- Only use Syncfusion Document Editor APIs — never recommend or use alternative Word Editor libraries.
- No temporary files — never create temporary scripts, intermediate files, or scaffolding outside the output directory
- C#-only code — all generated code must be valid C# and Razor for Blazor projects. No JavaScript, Python, or other languages.
1---2name: syncfusion-blazor-docx-editor3description: Use this skill when a user asks how to generate, integrate, or implement a Word‑like document editor in Blazor using Syncfusion. Trigger it for requests involving the Syncfusion Blazor Document Editor, Blazor‑based integration, document editing and formatting, comments and track changes, working with tables and images, managing headers and footers, applying document protection, and building end‑to‑end document workflows in Blazor applications.4---567# Syncfusion Blazor DOCX Editor 89## Overview10Generates production-ready C# and Razor code for integrating the Syncfusion DOCX Editor (Document Editor) into Blazor Server or WebAssembly applications. It provides ready-to-use snippets and best practices for embedding a Document Editor that supports editing, reviewing, formatting, and more.1112## Key Capabilities1314- **Document Editing:** Create, edit, and view Word documents.15- **Protection:** Apply read-only mode, allow comments, allow form filling, enforce tracked changes,and define editable ranges.16- **Review:** Enable track changes (revisions) and accept/reject changes.17- **Comments:** Add comments, replies, and author metadata.18- **Find and replace:** Perform programmatic find and replace operations for automation.19- **Form Fields:** Insert and fill text fields, check boxes, and dropdown form fields.2021## Prerequisites2223- .NET 8+ Blazor project (Server/WebAssembly/WebApp)24- NuGet packages: `Syncfusion.Blazor.WordProcessor`, `Syncfusion.Blazor.Themes`25- Syncfusion License: https://www.syncfusion.com/products/communitylicense2627## Quick Start Examples2829### Example 1: Display a basic DOCX Editor3031**User:** "Show me code to create a Document Editor component."3233**Result:** C# + Razor code snippet displayed3435### Example 2: Enable Read‑Only Restriction Mode3637**User:** "Create a Document Editor with Read‑Only restriction mode."3839**Result:** A Blazor snippet that creates a Document Editor with read‑only protection enabled.4041---4243## Generate C# Code for the User's Project *(default)*4445**Trigger keywords:** "code", "snippet", "how to", "show me", "sample", "example code", "generate code", "implement", "add to component", "configure documenteditor", "create" , "blazor document editor", "docx editor", "document editor", "track changes", "load docx", "comments", "accept changes", "protect document", "find and replace", "content control"464748**Workflow:**491. Analyze the user's request to identify the feature (e.g., track changes, restrict editing, toolbar customization).502. Read the relevant `references/*.md` file(s) to understand the APIs and code patterns for the requested feature.513. **STOP before generating code.** Check if the user has already chosen a delivery mode.524. **If no delivery mode is chosen yet**, you MUST ask the user first using this concise multiple-choice question:5354 **"How would you like to receive the generated code?"**55 56 - **Option 1:** Replace the code in a specific project file (you'll need to provide the file path and confirm)57 - **Option 2:** Share the code directly in the chat window58595. **Only after the user selects a delivery mode**, proceed to generate C# code using the APIs and snippets from `references/*.md`, substituting concrete placeholders from the user's project.606. **Do NOT make changes to workspace project files** unless the user explicitly chose Option 1 and provided the file path with permission.617. Provide complete C# snippets and concise integration steps after delivering the code.6263*Refer to `## Rules` section for operational constraints (output directory, temporary files, allowed libraries, etc.)*6465---6667## Code References6869All code snippets and examples are in the `references/` folder. Each file contains:70- **Minimal Code** — a working, ready-to-use snippet71- **Placeholders** — values the user must customize72- **Notes** — best practices, additional information to note while using that functionality, constraints7374| File | Contents |75|--------------------------------------|----------------------------------------------------|76| getting-started.md | Initialize Document Editor in Blazor WebAssembly |77| blazor-documenteditor-server.md | Initialize Document Editor in Blazor Server |78| blazor-documenteditor-webapp.md | Initialize Document Editor in Blazor Web App |79| form-fields.md | Insert, edit, and manage form fields |80| comments.md | Add, navigate, reply to, and manage comments |81| track-changes.md | Enable track changes and review document revisions |82| document-protection.md | Apply document protection and editing restrictions |83| spell-check.md | Enable and configure spell checking |84| customize-toolbar.md | Customize and control toolbar items |85| find-and-replace.md | Find and replace text |86| paste-formatting.md | Preserve clipboard formatting with paste support |87---8889## Key Rules for Code Generation90911. **No inline code in SKILL.md** — Always point to snippets in `references/*.md`. This file is loaded into context for every prompt; inline code wastes tokens.92932. **Snippets must be tested** — All code must compile and run against the current `Syncfusion.Blazor.WordProcessor` NuGet package version.94953. **Minimal Code + Placeholders + Notes** — Every reference file must include:96 - **Minimal Code** (complete, working snippet)97 - **Placeholders** (values user must substitute — marked with `{{ }}` or `[PLACEHOLDER]`)98 - **Notes** (best practices, framework-specific adaptations, constraints)991005. **Share code and notes for the requirement** — Never create temporary files or scripts.1011026. **License handling** — Never hardcode license keys. Point user to environment variables or config files.1031047. **Framework adaptation** — Default to C# + Razor. When user specifies framework.1051068. **No hallucinated APIs** — Use only verified Syncfusion DOCX Editor SDK method names. One wrong method breaks user trust.107108## Rules109110- **Only use Syncfusion Document Editor APIs** — never recommend or use alternative Word Editor libraries.111- **No temporary files** — never create temporary scripts, intermediate files, or scaffolding outside the output directory112- **C#-only code** — all generated code must be valid C# and Razor for Blazor projects. No JavaScript, Python, or other languages.
syncfusion