Back to Details

syncfusion-java-word

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Word (DOCX) Document Processing

Word（DOCX）文档处理

Overview

概述

Create, edit, and convert Word (.docx, .html) files using the Syncfusion Word Library. This skill supports one operational modes — generating java code for the user's project.
使用Syncfusion Word库创建、编辑和转换Word（.docx、.html）文件。此技能支持一种操作模式——为用户的项目生成Java代码。

Key Capabilities

核心功能

  • Create & Edit: Documents (.docx, .rtf, .txt, .xml, .html), paragraphs, headings, styles, lists, tables, shapes, images, hyperlinks, bookmarks, watermarks, headers/footers, form fields, content controls.
  • Advanced Features: Mail merge (DataTable, JSON, XML, custom objects), track changes, comments, mathematical equations (LaTeX), compare/split/merge documents.
  • Conversion: HTML ↔ DOCX, RTF ↔ DOCX, Text ↔ DOCX, XML ↔ DOCX
  • Security: Password encryption/decryption, document protection with editable ranges, macro management
  • 创建与编辑：文档（.docx、.rtf、.txt、.xml、.html）、段落、标题、样式、列表、表格、形状、图片、超链接、书签、水印、页眉/页脚、表单域、内容控件。
  • 高级功能：邮件合并（DataTable、JSON、XML、自定义对象）、修订跟踪、批注、数学公式（LaTeX）、文档比较/拆分/合并。
  • 格式转换：HTML ↔ DOCX、RTF ↔ DOCX、文本 ↔ DOCX、XML ↔ DOCX
  • 安全功能：密码加密/解密、带可编辑范围的文档保护、宏管理

Prerequisites

前提条件

Quick Start Examples

快速入门示例

Example 1: Generate Code (Mode 1)

示例1：生成代码（模式1）

User: "Show me how to create a Word document with a table"
Result: java code snippet displayed (no files created)
Workflow:
用户：“展示如何创建带有表格的Word文档”
**结果：**显示Java代码片段（不创建文件）
工作流程：

Step 1 — Suggest to add docio jars as references

步骤1 — 建议添加DocIO jar包作为引用

  • The following jar files are required to be referenced in your Java application.
  • syncfusion®-docio
  • syncfusion®-javahelper
  • Get the dependent jar files by installing file formats controls. You can find the required jars in the build installed drive.
  • Location: {ProgramFilesFolder}\Syncfusion\Essential Studio\ {Platform}\ {version}\JarFiles
  • Example: C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\18.3.0.35\JarFiles
  • 您的Java应用程序需要引用以下jar文件。
  • syncfusion®-docio
  • syncfusion®-javahelper
  • 您可以通过安装文件格式控件获取依赖的jar文件。所需jar包位于安装目录中。
  • 路径：{ProgramFilesFolder}\Syncfusion\Essential Studio\ {Platform}\ {version}\JarFiles
  • 示例：C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\18.3.0.35\JarFiles

Step 2 — Generate Code from Reference Files Only

步骤2 — 仅从参考文件生成代码

Do NOT invent, guess, or suggest any API, method, class, or packages not explicitly present in the reference files.
  • Read the relevant 
    references/*.md
    file(s) for the requested feature
  • Build java code strictly from the APIs and snippets found in those files
请勿发明、猜测或建议任何未在参考文件中明确提及的API、方法、类或包。
  • 阅读与所需功能相关的
    references/*.md
    文件
  • 严格根据这些文件中的API和代码片段构建Java代码

Code References

代码参考

All templates and snippets are in the 
references/
folder:
FileContents
document-structure.mdCreate/load document, add sections, page setup, save to file or stream, supported formats
styles-and-formats.mdParagraphs, headings, bullet & numbered lists
paragraph-and-styles.mdAdd paragraphs, paragraph formatting, styles (built-in/custom), text formatting, tab stops, breaks, symbols, text boxes
tables.mdCreate tables, cell formatting, merge cells
bookmarks.mdCreate bookmarks, navigate, retrieve, insert, replace, delete content
shapes.mdAdd shapes, format, rotate, group, ungroup shapes
mail-merge.mdSimple field merge, merge with regions (groups), nested merge, DataTable, dynamic objects, business objects, DataView, XML, JSON, image merge fields, merge events (MergeField, MergeImageField, BeforeClearField, BeforeClearGroupField), field mapping, retrieve merge field names, remove empty paragraphs, clear fields option
form-fields.mdAdd checkboxes, dropdowns, text input fields, modify properties
macros.mdLoad/save macro-enabled documents (DOTM, DOCM), check for macros, remove macros, preserve macros through conversion
mathematical-equation.mdCreate equations (fraction, radical, matrix, N-array, etc.), modify existing equations, LaTeX support, equation formatting
split-word-documents.mdSplit documents by sections, headings, bookmarks, placeholder text
merge-word-documents.mdMerge documents in new page, same page, maintain imported list styles
compare-word-documents.mdCompare two Word documents, set author and date, comparison options, ignore format changes
html-conversions.mdConvert HTML to DOCX, convert DOCX to HTML, XHTML validation, customize images (import/export), CSS selectors, export options, headers/footers export
rtf-conversions.mdConvert RTF to DOCX, convert DOCX to RTF, preserve formatting and content
markdown-conversion.mdConvert Markdown to DOCX, convert DOCX to Markdown, customize images, CommonMark and GitHub-flavored syntax support
text-conversions.mdConvert Text to DOCX, convert DOCX to Text, extract plain text, preserve text content
xml-conversions.mdConvert Word to XML (WordML), convert XML to Word, Word Processing XML format (2007+)
encryption.mdEncrypt with password, open encrypted doc, remove encryption, protect from editing, editable ranges
watermark.mdText and picture watermarks, watermark layout, scaling, washout effect, remove watermark
find-and-replace.mdFind/FindAll/FindNext, Replace (string/regex), ReplaceSingleLine, and FindItem* APIs
footnotes-and-endnotes.mdAdd footnotes and endnotes, set positions (bottom of page/end of section), numbering formats, separators, modify content, remove notes
track-changes.mdEnable/disable track changes, accept/reject changes, filter by reviewer, revision information
comments.mdAdd/modify/remove comments, insert on specific text, access parent comments, retrieve commented items
content-controls.mdBlock and inline content controls, types (rich text, plain text, checkbox, date, dropdown, picture), properties, protection, form filling, XML mapping
header-footer.mdAdd/remove headers and footers, page numbers with fields (date, time), odd/even pages, first page different, borders, images, link to previous
hyperlinks.mdWeb hyperlink, email hyperlink, file hyperlink, bookmark hyperlink, image hyperlink, modify hyperlink
所有模板和代码片段都位于
references/
文件夹中：
文件内容
document-structure.md创建/加载文档、添加节、页面设置、保存到文件或流、支持的格式
styles-and-formats.md段落、标题、项目符号和编号列表
paragraph-and-styles.md添加段落、段落格式、样式（内置/自定义）、文本格式、制表位、分隔符、符号、文本框
tables.md创建表格、单元格格式、合并单元格
bookmarks.md创建书签、导航、检索、插入、替换、删除内容
shapes.md添加形状、格式设置、旋转、组合、取消组合形状
mail-merge.md简单域合并、区域合并（分组）、嵌套合并、DataTable、动态对象、业务对象、DataView、XML、JSON、图片合并域、合并事件（MergeField、MergeImageField、BeforeClearField、BeforeClearGroupField）、域映射、检索合并域名、移除空段落、清除域选项
form-fields.md添加复选框、下拉菜单、文本输入域、修改属性
macros.md加载/保存启用宏的文档（DOTM、DOCM）、检查宏、移除宏、转换时保留宏
mathematical-equation.md创建公式（分数、根式、矩阵、N数组等）、修改现有公式、LaTeX支持、公式格式设置
split-word-documents.md按节、标题、书签、占位符文本拆分文档
merge-word-documents.md在新页面、同一页面合并文档、保留导入的列表样式
compare-word-documents.md比较两个Word文档、设置作者和日期、比较选项、忽略格式更改
html-conversions.mdHTML转DOCX、DOCX转HTML、XHTML验证、自定义图片（导入/导出）、CSS选择器、导出选项、页眉/页脚导出
rtf-conversions.mdRTF转DOCX、DOCX转RTF、保留格式和内容
markdown-conversion.mdMarkdown转DOCX、DOCX转Markdown、自定义图片、支持CommonMark和GitHub风格语法
text-conversions.md文本转DOCX、DOCX转文本、提取纯文本、保留文本内容
xml-conversions.mdWord转XML（WordML）、XML转Word、文字处理XML格式（2007+）
encryption.md密码加密、打开加密文档、移除加密、编辑保护、可编辑范围
watermark.md文本和图片水印、水印布局、缩放、冲蚀效果、移除水印
find-and-replace.mdFind/FindAll/FindNext、Replace（字符串/正则）、ReplaceSingleLine和FindItem* API
footnotes-and-endnotes.md添加脚注和尾注、设置位置（页面底部/节末尾）、编号格式、分隔符、修改内容、移除注释
track-changes.md启用/禁用修订跟踪、接受/拒绝更改、按审阅者筛选、修订信息
comments.md添加/修改/删除批注、在特定文本上插入、访问父批注、检索带批注的项目
content-controls.md块级和内联内容控件、类型（富文本、纯文本、复选框、日期、下拉菜单、图片）、属性、保护、表单填写、XML映射
header-footer.md添加/移除页眉和页脚、带域的页码（日期、时间）、奇偶页不同、首页不同、边框、图片、链接到前一节
hyperlinks.md网页超链接、邮件超链接、文件超链接、书签超链接、图片超链接、修改超链接

Rules

规则

  • Use license key from 
    SyncfusionLicense.txt
    at workspace root or env var 
    SYNCFUSION_LICENSE_KEY
  • Never use Python libraries (e.g., python-docx)
  • 使用工作区根目录下
    SyncfusionLicense.txt
    中的许可证密钥，或环境变量
    SYNCFUSION_LICENSE_KEY
  • 切勿使用Python库（例如python-docx）