Skip to content
DemoFAQ

PDF 生成模板编辑器

开源可视化 PDF 生成引擎,支持自定义模板,并提供面向开发者的 API,灵活构建文档生成流程。

查看 GitHub

Word 转 PDF ​

概述 ​

ComPDF Conversion SDK 支持将 Word 文档转换为 PDF 文件,可选择生成 PDF 书签,也可以只输出指定的页面。

基本用法 ​

c#
string inputFilePath = "***";
string outputFileName = "***";

ErrorCode error = CPDFConversion.StartWordToPDF(inputFilePath, outputFileName);

设置书签与页面范围 ​

Word 转 PDF 复用 WordOptions,其中只有 WordPdfBookmarkMode(书签生成方式)与 PageRanges(输出页面范围)生效,其他设置不生效:

选项类型默认值含义
WordPdfBookmarkModeWordPdfBookmarkModee_None如何生成 PDF 书签(阅读器导航栏中的目录)
PageRangesstring空指定输出的页码,如 "1-3,5,7-9";空表示输出所有页

WordPdfBookmarkMode 的取值:

值含义
e_None不生成书签
e_Headings每个标题(带大纲级别的段落)生成一个书签,按级别嵌套
e_WordBookmarks每个 Word 书签生成一个书签,书签名与 Word 中一致
c#
WordOptions options = new WordOptions();
options.WordPdfBookmarkMode = WordPdfBookmarkMode.e_Headings;
options.PageRanges = "1-3,5,7-9";

ErrorCode error = CPDFConversion.StartWordToPDF(inputFilePath, outputFileName, options);

获取进度与取消 ​

与其他转换接口一样,可通过 ConvertCallback 获取进度或取消转换:

c#
OnProgress getProgress = (pageIndex, total) =>
{
    // 在此位置添加回调函数的代码。
};

ConvertCallback callback = new ConvertCallback();
callback.progress = Marshal.GetFunctionPointerForDelegate(getProgress);

ErrorCode error = CPDFConversion.StartWordToPDF(inputFilePath, outputFileName, options, callback);

诊断信息 ​

文档里有可能影响还原度的特性时,转换会返回 ErrorCode.e_ErrUnsupportedFeature(95)。此时 PDF 通常仍会生成,可通过带 out string diagnostics 参数的重载获取诊断文本:

c#
string diagnostics;
ErrorCode error = CPDFConversion.StartWordToPDF(inputFilePath, outputFileName, options, out diagnostics);
if (error == ErrorCode.e_ErrUnsupportedFeature)
{
    // 第一行为 output=produced 或 output=not_produced。
    Console.WriteLine(diagnostics);
}
  • 诊断文本为 UTF-8 编码,由 SDK 内部分配缓冲区(8192 字节),无需调用方准备缓冲区。
  • 诊断文本第一行 output=produced 表示已生成 PDF,output=not_produced 表示未生成完整的 PDF。
  • 之后每行是一条“特性标识:原因”,例如 ruby:unsupported ruby layout。同一次转换中相同特性只报一次。
  • 转换本身失败时返回真实的错误码,优先于 95。
  • 缓冲区放不下完整诊断时返回 ErrorCode.e_ErrOutOfMemory,诊断不会被截断。