关于 syncfusion-wpf-docx-editor
面向开发者的技能,用于生成将 Syncfusion WPF DOCX Editor 集成到应用的 C# 和 XAML 示例,涵盖编辑、评论、保护及导入导出,并在生成前确认代码交付方式。
主要功能
- 01C# 和 XAML 集成示例
- 02文档编辑与格式设置
- 03评论与文档保护
- 04文档格式导入导出
- 05查找与替换
- 06生成前确认交付方式
适用场景
- 01在 WPF 项目中集成 SfRichTextBoxAdv
- 02添加评论或限制文档编辑
- 03打开并保存 DOCX 等支持的格式
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ syncfusion/ docx-editor-sdk-skills --skill syncfusion-wpf-docx-editor安装后在 Claude Code 中输入/syncfusion-wpf-docx-editor确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdreferences/automatic-suggestion.mdbackground.mdcharacter-format.mdclipboard.mdcommands.mdcomments.mddetermine-editing-context-type.mddialogs.mddocument-editor.mddocument-properties.mdfind-and-replace.mdhyperlink.mdimage.mdlayout-types.mdlists.mdlocalization.mdlost-focus-behavior.mdminitoolbar.mdmvvm.mdopen-document.mdparagraph-format.mdprint.mdsave-document.mdsection-format.mdselection.mdshapes.mdspellchecker.mdstyles.mdtable.md详细介绍
Syncfusion WPF DOCX 编辑器
概述
此技能可帮助开发者生成 WPF 代码,将 Syncfusion DOCX 编辑器集成到应用程序中。它提供可直接使用的代码片段和最佳实践,帮助嵌入支持编辑、审阅、格式设置等功能的 SfRichTextBoxAdv。
核心功能
- 文档编辑: 创建、编辑和查看 Word 文档。
- 保护: 设置只读模式,允许添加评论。
- 评论: 添加评论和回复,并在评论之间导航。
- 查找和替换: 执行程序化查找和替换操作,以实现自动化。
- 导入/导出: 打开和保存 .doc/.docx/.rtf/.html/.xaml/.txt。
- 剪贴板: 复制、剪切和粘贴带格式的富内容。
- 超链接: 插入、编辑和访问超链接。
先决条件
- NuGet 包:Syncfusion.SfRichTextBoxAdv.WPF
- Syncfusion 许可证:https://www.syncfusion.com/products/communitylicense
快速入门示例
示例 1:创建文档编辑器
用户:“给我展示创建文档编辑器组件的代码。”
**结果:**初始化 SfRichTextBoxAdv 的 WPF XAML + C# 代码片段。
示例 2:启用只读限制模式
用户:“创建一个启用了只读限制模式的文档编辑器。”
**结果:**在初始化期间加载文档并应用只读保护的 C# 代码片段。
为用户的项目生成 C# 代码 (默认)
触发关键词:“代码”、“代码片段”、“如何做”、“如何编写”、“给我展示”、“示例”、“示例代码”、“生成代码”、“为……生成代码”、“实现”、“实现方式”、“创建”、“集成”、“添加到组件”、“添加到项目”、“配置 documenteditor”、“API 示例”、“用法示例”、“我该怎么做”、“如何使用”、“文档编辑器”、“WPF 文档编辑器”、“DOCX 编辑器”、“WPF DOCX 编辑器”、“加载 DOCX”、“评论”、“保护文档”、“查找和替换”、“MainWindow.xaml”、“NuGet”、“sfrichtextboxadv”、“sfrichtextribbon”
工作流:
-
分析用户的请求,确定所需功能(例如,评论、查找和替换、导入和导出)。
-
阅读相关的
references/*.md文件,了解所需功能对应的 API 和代码模式。 -
**生成代码前先停止。**检查用户是否已选择交付方式。
-
如果用户尚未选择交付方式,必须先用以下简洁的选择题询问用户:
“您希望如何接收生成的代码?”
- **选项 1:**替换特定项目文件中的代码(需要提供文件路径并确认)
- **选项 2:**直接在聊天窗口中分享代码
-
只有在用户选择交付方式后,才能使用
references/*.md中的 API 和代码片段生成 WPF 代码,并将具体占位内容替换为用户项目中的对应内容。 -
除非用户明确选择选项 1,并在获得许可后提供文件路径,否则不得修改工作区项目文件。
-
提供代码后,给出完整的 WPF 代码片段和简洁的集成步骤。
有关操作限制(输出目录、临时文件、允许使用的库等),请参阅 ## Rules 部分。
代码参考
所有代码片段和示例都位于 references/ 文件夹中。每个文件都包含:
- 最简 React 代码 — 可运行、可直接使用的代码片段
- 占位符 — 用户必须自定义的值
- 备注 — 最佳实践、使用该功能时需注意的补充信息和限制
| 文件 | 用途 |
|---|---|
| automatic-suggestion.md | 使用 @ 字符配置自动文本建议和提及功能。 |
| background.md | 自定义文档和编辑器控件的背景。 |
| character-format.md | 设置字体系列、字号、样式和颜色等字符格式。 |
| clipboard.md | 在文档编辑器中执行复制、剪切和粘贴操作。 |
| commands.md | 使用内置编辑器命令并配置命令绑定。 |
| comments.md | 插入、管理、回复、导航和删除文档批注。 |
| determine-editing-context-type.md | 确定当前编辑上下文(文本、表格、图像等)。 |
| dialogs.md | 使用内置对话框并自定义其外观和行为。 |
| document-editor.md | 创建、初始化和配置 WPF DOCX 编辑器。 |
| document-properties.md | 查看字数、页数和当前页等文档统计信息。 |
| find-and-replace.md | 搜索文本并执行查找和替换操作。 |
| hyperlink.md | 在文档中插入、编辑和管理超链接。 |
| image.md | 在文档中插入和管理图像。 |
| layout-types.md | 在页面布局模式(Pages / Continuous / Blocks)之间切换。 |
| lists.md | 创建和管理项目符号列表与编号列表。 |
| localization.md | 使用 .resx 资源和 UI 区域性设置进行本地化。 |
| lost-focus-behavior.md | 编辑器失去焦点时,保持插入光标和选区高亮可见。 |
| minitoolbar.md | 启用和禁用迷你工具栏,以便快速设置格式。 |
| mvvm.md | 使用数据绑定和视图模型,将文档编辑器集成到 MVVM 中。 |
| open-document.md | 使用同步和异步 API 从文件、流和内存中打开并加载文档。 |
| paragraph-format.md | 设置对齐、间距和缩进等段落格式。 |
| print.md | 打印文档内容并配置打印行为。 |
| save-document.md | 使用同步和异步 API 将文档保存并导出到文件和流。 |
| section-format.md | 配置页面大小、页边距和页眉/页脚等节级设置。 |
| selection.md | 使用文本选区 API 进行导航、设置格式以及通过键盘选择文本。 |
| shapes.md | 保留并操作从导入文档中获取的文本框和矩形等形状。 |
| spellchecker.md | 启用拼写检查并配置选项和自定义词典。 |
| styles.md | 创建、应用、修改和清除字符、段落、表格及链接样式。 |
| table.md | 创建和操作表格,包括行、列、单元格和对齐方式。 |
| template-and-styling-document-editor.md | 自定义控件模板、样式、上下文菜单、窗格以及编辑器 UI 的整体外观。 |
| undo-redo.md | 撤销和重做文档编辑操作,并配置撤销行为。 |
| virtualization.md | 启用 UI 虚拟化并应用性能优化技术。 |
代码生成的关键规则
-
SKILL.md 中不得包含内联代码 — 始终引用
references/*.md中的代码片段。此文件会在每次提示时加载到上下文中;内联代码会浪费令牌。 -
代码片段必须经过测试 — 所有代码都必须能使用当前的 Syncfusion WPF NuGet 包(例如,Syncfusion.SfRichTextBoxAdv.WPF)和受支持的 .NET 目标框架进行构建和运行。
-
精简代码 + 占位符 + 说明 — 每个参考文件都必须包含:
- 精简代码(完整且可运行的代码片段)
- 占位符(用户必须替换的值,以
{{ }}或[PLACEHOLDER]标记) - 说明(最佳实践、特定于框架的调整、限制)
-
针对需求共享代码和说明 — 不得创建临时文件或脚本。
-
许可证处理 — 不得硬编码许可证密钥。引导用户使用环境变量或配置文件。
-
框架适配 — 默认使用 C# + XAML。用户指定框架时。
-
不得编造 API — 只能使用经过验证的 Syncfusion DOCX Editor SDK 方法名称。一个错误的方法就会失去用户的信任。
规则
- 只能使用 Syncfusion SfRichTextBoxAdv API — 不得推荐或使用其他 Word 编辑器库。
- 不得创建临时文件 — 不得在输出目录之外创建临时脚本、中间文件或脚手架
- 仅使用 C# 代码 — 所有生成的代码都必须是适用于 WPF 项目的有效 C# 和 XAML。不得使用 JavaScript、TypeScript 或其他语言。