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