关于 syncfusion-aspnetmvc-docx-editor
面向开发者的编码技能,用于生成在 ASP.NET MVC(C#)应用中集成 Syncfusion DOCX Editor 的代码,涵盖编辑、审阅和保护功能,并在生成前要求选择代码交付方式。
主要功能
- 01生成 ASP.NET MVC(C#)代码片段
- 02编辑和格式化文档
- 03保护文档并限制编辑
- 04审阅修订并管理评论
- 05查找替换和表单字段
适用场景
- 01在 MVC 视图中加入 Syncfusion Document Editor
- 02启用修订跟踪或只读模式
- 03添加评论或管理表单字段
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ syncfusion/ docx-editor-sdk-skills --skill syncfusion-aspnetmvc-docx-editor安装后在 Claude Code 中输入/syncfusion-aspnetmvc-docx-editor确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdreferences/collaborative-editing-mvc.mdcomments.mdcustomize-toolbar.mddocument-protection.mdeditor-only.mdfind-and-replace.mdform-fields.mdgetting-started.mdinsert-text-box.mdpaste-formatting.mdribbon.mdtrack-changes.md详细介绍
Syncfusion ASP.NET MVC DOCX 编辑器
概述
此技能可帮助开发者生成 ASP.NET MVC(C#)代码,以便在应用程序中集成 Syncfusion DOCX 编辑器。它提供开箱即用的代码片段和最佳实践,用于嵌入支持编辑、审阅、格式设置等功能的文档编辑器。
主要功能
- 文档编辑: 创建、编辑和查看 Word 文档。
- 保护: 应用只读模式、允许评论、允许填写表单、强制启用修订,并定义可编辑区域。
- 审阅: 启用修订(修订记录)并接受或拒绝更改。
- 评论: 添加评论、回复和作者元数据。
- 查找和替换: 以编程方式执行查找和替换操作,实现自动化。
- 表单字段: 插入并填写文本字段、复选框和下拉表单字段。
先决条件
- NuGet 包:
Syncfusion.EJ2.WordEditor.AspNet.Mvc5(或特定框架的包装程序) - Syncfusion 许可证:https://www.syncfusion.com/products/communitylicense
快速入门示例
示例 1:创建带功能区的可编辑文档编辑器
用户:“创建一个带功能区 UI 的文档编辑器组件”
**结果:**一段用于呈现带功能区 UI 的文档编辑器的 ASP.NET MVC 代码片段。
示例 2:启用只读限制模式
用户:“创建一个启用只读限制模式的文档编辑器。”
**结果:**一段创建启用只读保护的文档编辑器的 ASP.NET MVC 代码片段。
开始使用 — 最精简的 ASP.NET MVC(C#)代码
适用于普通 Web 项目的最精简 ASP.NET MVC 文档编辑器设置:
在 ~/Views/Home/Index.cshtml 页面中添加 Syncfusion® ASP.NET MVC DocumentEditor 标记帮助程序。
例如,将文档编辑器容器组件添加到 ~/Views/Home/Index.cshtml 页面。
@Html.EJS().DocumentEditorContainer("container").Render()
为用户的项目生成 ASP.NET MVC(C#)代码
触发关键词:“code”、“snippet”、“how to”、“show me”、“sample”、“example code”、“generate code”、“implement”、“add to view”、“configure documenteditor”、“create”、“asp.net mvc document editor”、“docx editor”、“document editor”、“track changes”、“load docx”、“export pdf”、“comments”、“accept changes”、“insert table”、“insert image”、“table of contents”、“protect document”、“content control”
工作流:
-
分析用户的请求,确定所需功能(例如,修订、限制编辑、自定义工具栏)。
-
阅读相关的
references/*.md文件,了解所请求功能对应的 API 和代码模式。 -
生成代码前先停止。 检查用户是否已选择交付方式。
-
**如果用户尚未选择交付方式,**必须先用以下简洁的单选问题询问用户:
“你希望如何接收生成的代码?”
- **选项 1:**替换特定项目文件中的代码(你需要提供文件路径并确认)
- **选项 2:**直接在聊天窗口中分享代码
-
**只有在用户选择交付方式后,**才能使用
references/*.md中的 API 和代码片段生成 ASP.NET MVC(C#)代码,并将具体占位内容替换为用户项目中的实际内容。 -
除非用户明确选择选项 1,并提供文件路径和许可,否则不得修改工作区项目文件。
-
提供完整的 ASP.NET MVC 代码片段,并在交付代码后附上简洁的集成步骤。
操作限制(输出目录、临时文件、允许使用的库等)请参阅 ## Key Rules 部分。
代码参考
所有代码片段和示例都位于 references/ 文件夹中。每个文件包含:
- 最简 ASP.NET MVC (C#) 代码 — 可运行、可直接使用的代码片段
- 占位符 — 用户必须自定义的值
- 说明 — ASP.NET MVC 最佳实践和框架特定的适配方式
| 文件 | 主题 |
|---|---|
| comments.md | 插入、管理和删除评论 |
| customize-toolbar.md | 自定义工具栏项 |
| getting-started.md | 初始化文档编辑器 (Razor/Cshtml) |
| document-protection.md | 保护并限制文档编辑 |
| editor-only.md | 仅编辑器模式初始化 |
| find-and-replace.md | 查找和替换文本 |
| form-fields.md | 创建和管理表单字段 |
| paste-formatting.md | 保留粘贴格式(服务器端) |
| insert-text-box.md | 插入文本框对话框 |
| ribbon.md | 使用 Ribbon UI 初始化 documentEditor |
| track-changes.md | 跟踪更改并管理修订 |
| collaborative-editing-mvc.md | 使用 Collaboration Client 和 Server 进行协同编辑(ASP.NET CoMVCre 后端) |
代码生成关键规则
-
SKILL.md 中不得包含内联代码 — 始终指向
references/*.md中的代码片段。每次提示都会将此文件加载到上下文中;内联代码会浪费令牌。 -
必须测试代码片段 — 所有代码都必须能针对当前的
Syncfusion.EJ2.WordEditor.AspNet.Mvc5编译并运行 -
最简代码 + 占位符 + 说明 — 每个参考文件都必须包含:
- 最简代码(完整、可运行的代码片段)
- 占位符(用户必须替换的值 — 使用
{{ }}或[PLACEHOLDER]标记) - 说明(最佳实践、框架特定的适配方式和限制)
-
仅使用 Syncfusion API — 绝不推荐竞品库
-
针对需求提供代码和说明 — 绝不创建临时文件或脚本。
-
许可证处理 — 绝不硬编码许可证密钥。引导用户使用环境变量或配置文件。
-
框架适配 — 默认使用原生 JavaScript/TypeScript。用户指定框架时除外。
-
不得臆造 API — 仅使用经过验证的 Syncfusion DOCX Editor SDK 方法名。一个错误的方法就会失去用户信任。
-
经典 .csproj 注册 — ASP.NET MVC 5 项目使用经典(非 SDK)
.csproj文件。每个新生成的.cs文件都必须添加为<Compile Include="...">条目;每个新的 NuGet 程序集都必须添加为带有HintPath的<Reference>(并在packages.config中添加相应条目),否则该文件会被静默排除在编译之外,导致构建失败。请参阅references/collaborative-editing-mvc.md→“在项目中注册新文件 (.csproj)”。
规则
-
仅使用 Syncfusion Document Editor API — 绝不推荐或使用其他 Word Editor 库。
-
不得创建临时文件 — 绝不在输出目录之外创建临时脚本、中间文件或脚手架文件
-
仅限 ASP.NET MVC (C#) 代码 — 所有生成的代码都必须是有效的 ASP.NET MVC (C#),绝不生成原生 JavaScript、jQuery 或非 ASP.NET MVC (C#) 模式