本教程详细介绍了在nreco.pdfgenerator中自定义pdf页面编号的两种高级方法。首先，通过`generatepdffromfiles`方法结合`–page-offset`参数，实现对不同html输入文件的起始页码控制；其次，展示了如何通过修改页脚html中的javascript代码，实现更灵活的页码逻辑定制，例如跳过特定页码。这些方法能帮助开发者精确控制生成pdf的页码显示。
NReco.PdfGenerator是一个基于wkhtmltopdf的.net库，用于将HTML内容转换为PDF。在生成PDF时，页码的显示是一个常见的需求，而默认的页码通常是按顺序递增的（例如：1, 2, 3…）。然而，在某些特定场景下，我们可能需要更灵活的页码控制，例如让第一页显示为“Page 1”，而第二页直接显示为“Page 3”，跳过“Page 2”。本文将详细介绍两种实现这种高级页码自定义的方法。
方法一：使用GeneratePdfFromFiles与–page-offset参数
当您的PDF内容可以逻辑上分割成多个独立的html文件时，这种方法非常适用。通过为每个HTML文件指定不同的页码偏移量，可以实现灵活的页码起始设置。
核心原理： NReco.PdfGenerator的GeneratePdfFromFiles方法允许您传入一个WkHtmlInput对象数组，每个对象代表一个要转换的HTML文件。WkHtmlInput类提供了一个CustomWkHtmlPageArgs属性，您可以在其中设置wkhtmltopdf的命令行参数，包括–page-offset。–page-offset N参数会将当前文件的所有页码都加上N。
实现步骤：
- 准备多个HTML输入： 将需要特殊页码处理的内容分割成不同的HTML文件或字符串。
- 创建WkHtmlInput对象： 为每个HTML输入创建一个WkHtmlInput实例。
- 设置CustomWkHtmlPageArgs： 对于需要从特定页码开始的HTML输入，设置其CustomWkHtmlPageArgs属性为” –page-offset N “，其中N是您希望的页码偏移量。例如，如果您希望第二部分从页码3开始，而wkhtmltopdf默认会将其第一页编号为2（因为它是第二个输入），那么您需要设置–page-offset 1（即2+1=3）。如果希望它从页码3开始，且它的实际内部页码是1，那么偏移量应为2（1+2=3）。
示例代码：
以下示例展示了如何生成一个PDF，其中第一个HTML文件（first.html）的页码从1开始，而第二个HTML文件（main.html）的页码从3开始。
using NReco.PdfGenerator; using System; using System.IO; // for creating dummy HTML files public class PdfPageNumberCustomization { public void GeneratePdfWithOffsetPages() { // 创建模拟的HTML文件内容 string firstPageHtml = "<html><body><h1>First Page</h1><p>This is the content for page 1.</p></body></html>"; string mainPageHtml = "<html><body><h1>Main Content</h1><p>This section will start from page 3.</p><p>More content...</p></body></html>"; // 将内容写入临时文件，或直接使用HTML字符串 // 这里为了演示WkHtmlInput，我们假设有文件 File.WriteAllText("first.html", firstPageHtml); File.WriteAllText("main.html", mainPageHtml); var htmlToPdf = new HtmlToPdfConverter(); // 定义统一的页脚HTML string footerHtml = "<table style="border-bottom: 1px solid black; width: 100%"><tr><td class="section"></td><td style="text-align:right">Page <span class="page"></span></td></tr></table>"; htmlToPdf.GeneratePdfFromFiles( new WkHtmlInput[] { // 第一个文件，页码从1开始，无需特殊偏移 new WkHtmlInput("first.html") { PageFooterHtml = footerHtml }, // 第二个文件，设置页码偏移量为2。 // 如果wkhtmltopdf默认会将其内部页码计为1，那么1 + 2 = 3。 // 这样，第二个文件的第一页将显示为“Page 3”。 new WkHtmlInput("main.html") { CustomWkHtmlPageArgs = " --page-offset 2 ", // 页码将变为: 3, 4, 5 等 PageFooterHtml = footerHtml } }, null, // 可选的封面页HTML "output_with_offset.pdf" ); Console.WriteLine("PDF generated with custom page offsets: output_with_offset.pdf"); // 清理临时文件 File.Delete("first.html"); File.Delete("main.html"); } }
适用场景与注意事项：
- 适用于文档结构清晰，可以逻辑分割成多个部分的场景。
- –page-offset参数是基于wkhtmltopdf内部的页码计数进行偏移的。如果一个WkHtmlInput是整个PDF的第N个输入，其内部页码从1开始，那么实际显示的页码将是 N (内部页码) + 偏移量。
- 此方法相对简单直观，但要求内容可以被有效分割。
方法二：通过javaScript覆盖页脚逻辑
这种方法提供了更细粒度的控制，允许您在页脚的HTML中嵌入javascript代码，直接修改页码的显示逻辑。wkhtmltopdf在渲染页脚时会执行其中包含的JavaScript。
核心原理： wkhtmltopdf在页脚或页眉中遇到特定类名（如<span class=”page”></span>）时，会通过一个内置的JavaScript函数来填充这些占位符。这个函数通常命名为subst，并从URL查询字符串中获取页码等信息。通过在您的PageFooterHtml中定义一个同名的window.subst函数，您可以覆盖其默认行为，实现自定义的页码计算和显示逻辑。
实现步骤：
- 准备页脚HTML： 确保您的页脚HTML中包含一个或多个<span>元素，其class属性设置为page（或其他wkhtmltopdf支持的页码相关类，如frompage, topage）。
- 嵌入自定义JavaScript： 在PageFooterHtml字符串中嵌入一个<script>标签，并在其中定义您的window.subst函数。
- 实现自定义逻辑： 在window.subst函数内部，您可以访问wkhtmltopdf传递的各种页码变量，并根据您的需求进行修改。
示例代码：
以下示例展示了如何实现“第一页显示为Page 1，第二页显示为Page 3，之后按顺序递增”的逻辑。
using NReco.PdfGenerator; using System; public class PdfAdvancedPageNumberCustomization { public void GeneratePdfWithCustomjsPages() { var htmlContent = String.Format("<body><h1>Page 1 Content</h1><p>This is the first page.</p><div style='page-break-before: always;'></div><h1>Page 2 Content (will display as Page 3)</h1><p>This is the second page, but we want it to be page 3.</p><div style='page-break-before: always;'></div><h1>Page 3 Content (will display as Page 4)</h1><p>This is the third page, but we want it to be page 4.</p></body>", DateTime.Now); var htmlToPdf = new HtmlToPdfConverter(); // 包含自定义JavaScript的页脚HTML htmlToPdf.PageFooterHtml = @" <script> window.subst = function() { var vars={}; var x=document.location.search.substring(1).split('&'); for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = unescape(z[1]);} var x=['frompage','topage','page','webpage','section','subsection','subsubsection']; for(var i in x) { var y = document.getElementsByClassName(x[i]); var val = vars[x[i]]; // 核心逻辑：如果当前页码大于1，则将其加1 // 这样，第1页显示1，第2页显示3，第3页显示4，以此类推。 if (x[i]=='page' && parseInt(val)>1) { val = parseInt(val)+1; } for(var j=0; j<y.Length; ++j) y[j].textContent = val; } } </script> <table border-bottom: 1px solid black; width: 100%""> <tr> <td class=""section""></td> <td text-align:right"">Page <span class=""page""></span></td> </tr> </table> "; var pdfBytes = htmlToPdf.GeneratePdf(htmlContent); // 将生成的PDF保存到文件 File.WriteAllBytes("output_with_custom_js_pages.pdf", pdfBytes); Console.WriteLine("PDF generated with custom JS page numbering: output_with_custom_js_pages.pdf"); } }
代码解析：
- window.subst = function() { … }：这是wkhtmltopdf用于填充页眉/页脚占位符的默认函数。通过重新定义它，我们可以完全控制其行为。
- var x=document.location.search.substring(1).split(‘&’);：wkhtmltopdf在调用subst函数时，会将页码、总页数等信息作为URL查询字符串传递给页脚的HTML。这行代码用于解析这些参数。
- var vars={}; … for(var i in x) {var z=x[i].split(‘=’,2);vars[z[0]] = unescape(z[1]);}：将查询字符串解析为键值对存储在vars对象中。
- var x=[‘frompage’,’topage’,’page’,…]：wkhtmltopdf支持的页码相关类名列表。
- if (x[i]==’page’ && parseInt(val)>1) val = parseInt(val)+1;：这是实现自定义逻辑的关键部分。它检查当前处理的类名是否是page，并且页码值大于1。如果满足条件，则将页码值加1。
- for(var j=0; j<y.length; ++j) y[j].textContent = val;：找到所有具有当前类名的<span>元素，并用计算出的val更新其文本内容。
适用场景与注意事项：
- 适用于需要复杂、动态或条件性页码逻辑的场景，即使内容在一个单一的HTML文件中。
- 需要对JavaScript有一定的了解，并熟悉wkhtmltopdf的页眉/页脚处理机制。
- 调试JavaScript在wkhtmltopdf环境中的执行可能比较复杂，建议从小范围测试开始。
- 可以参考wkhtmltopdf官方文档中关于页眉和页脚的说明（例如：wkhtmltopdf.org/usage/wkhtmltopdf.txt）来获取更多关于可用变量和JS执行环境的信息。
总结
NReco.PdfGenerator结合wkhtmltopdf提供了强大的PDF生成能力，包括对页码的灵活控制。
- 当您的PDF内容可以自然地分割成多个独立部分时，方法一（GeneratePdfFromFiles与–page-offset） 提供了一种简单有效的方式来控制各部分的起始页码。
- 当您需要更精细、更动态的页码逻辑时，方法二（通过JavaScript覆盖页脚逻辑） 提供了最大的灵活性，允许您根据具体需求编写自定义的页码计算规则。
选择哪种方法取决于您的具体需求和文档结构。在实现过程中，建议充分测试以确保页码显示符合预期。