本文详细介绍了在nreco.pdfgenerator中自定义pdf页码的两种实用方法。第一种方法利用`generatepdffromfiles`通过文件拆分和`–page-offset`参数实现灵活的页码起始设置；第二种方法则通过覆盖页脚html中的javascript逻辑，实现更精细的页码计算与显示控制。这两种方案能有效解决特定页码编排需求，确保生成的pdf文档符合业务逻辑。
在使用NReco.PdfGenerator生成PDF文档时，默认的页码通常从1开始递增。然而，在某些复杂的文档生成场景中，我们可能需要对页码进行非标准的定制，例如让第二页显示为页码3，或者从一个特定的数字开始计数。NReco.PdfGenerator提供了两种主要方法来实现这种灵活的页码定制。
方法一：利用 GeneratePdfFromFiles 和 CustomWkHtmlPageArgs
如果您的PDF内容可以逻辑上拆分成多个独立的HTML部分，并且希望每个部分或从某个特定页开始重新计算页码，那么GeneratePdfFromFiles方法结合–page-offset参数是一个非常有效的解决方案。这种方法适用于文档结构清晰、各部分页码需求独立的场景。
实现原理：GeneratePdfFromFiles方法允许您将多个WkHtmlInput对象作为输入，每个WkHtmlInput代表一个独立的HTML源文件或字符串。通过为特定的WkHtmlInput实例设置CustomWkHtmlPageArgs属性，我们可以向wkhtmltopdf引擎传递自定义命令行参数，其中–page-offset参数用于指定该输入内容开始时的页码偏移量。
示例代码：
using NReco.PdfGenerator;using System;using System.IO;public class PdfPageNumberCustomization{ public void GenerateCustomPagedPdf() { // 假设有两个HTML文件内容 string firstPageHtml = "第一页内容
这是文档的第一部分，页码将显示为1。
"; string mainContentHtml = "主内容
这是文档的主要部分，我们希望它的页码从3开始。
下一页这是主内容的第二页。
"; // 将HTML内容写入临时文件，以便GeneratePdfFromFiles使用 File.WriteAllText("first.html", firstPageHtml); File.WriteAllText("main.html", mainContentHtml); var htmlToPdf = new HtmlToPdfConverter(); // 设置全局页脚HTML模板 string footerHtmlTemplate = "| Page |
代码解释：
我们创建了两个WkHtmlInput实例，分别对应“first.html”和“main.html”。对于“main.html”对应的WkHtmlInput，我们设置了CustomWkHtmlPageArgs = ” –page-offset 2 “。这意味着wkhtmltopdf在处理这部分内容时，会将内部页码计数器增加2。因此，如果“first.html”的最后一页是1，那么“main.html”的第一页将显示为1 + 2 = 3。PageFooterHtml属性可以为每个WkHtmlInput单独设置，但在这个例子中，我们使用了相同的模板。
方法二：覆盖页脚HTML中的JavaScript逻辑
当您无法将内容拆分为多个HTML输入，或者需要更复杂的页码计算逻辑时，可以通过修改页脚HTML中嵌入的JavaScript代码来直接控制页码的显示。wkhtmltopdf在生成页脚时，会执行一段内置的JavaScript代码来填充等占位符。我们可以覆盖这段默认逻辑，实现自定义的页码计算。
实现原理：wkhtmltopdf允许在页眉或页脚HTML中嵌入JavaScript代码。这段JS代码会在PDF渲染时被执行，并且可以访问一些由wkhtmltopdf提供的全局变量（如vars对象中的page、frompage等）。通过修改这些变量或它们的显示方式，我们可以改变最终页码的呈现。
示例代码：
using NReco.PdfGenerator;using System;public class PdfPageNumberJavaScriptOverride{ public void GeneratePdfWithJsOverride() { var htmlContent = String.Format("Hello world: {0}
这是第二页这是第二页的内容，希望显示为页码3。
", DateTime.Now); var htmlToPdf = new HtmlToPdfConverter(); // 覆盖默认的页脚HTML，并嵌入自定义JavaScript htmlToPdf.PageFooterHtml = @" window.subst = function() { // var pageOffset = 20; // 示例：如果需要全局偏移量，第一页将变为21 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 if (x[i]=='page' && parseInt(val)>1) val = parseInt(val)+1; // 结果将是：1, 3, 4, 5 等 for(var j=0; j<y.length; ++j) y[j].textContent = val; } } | Page |
代码解释：
我们将一个包含标签的HTML字符串赋值给PageFooterHtml。window.subst = function() { … } 是wkhtmltopdf内部约定用于填充页眉/页脚占位符的函数。我们在这里覆盖了它的实现。JS代码首先解析了URL查询参数，这些参数包含了wkhtmltopdf提供的页面信息（如page、frompage等）。核心定制逻辑在于：if (x[i]==’page’ && parseInt(val)>1) val = parseInt(val)+1;。这段代码检查当前处理的占位符是否是“page”，并且其值（val）如果大于1（即不是第一页），则将val加1。这样，第一页显示为1，第二页显示为3，第三页显示为4，依此类推。最后，通过y[j].textContent = val;将计算后的值更新到相应的HTML元素中。
注意事项：
这种方法要求您对JavaScript有一定的了解，并熟悉wkhtmltopdf的页眉/页脚工作机制。您可以查阅wkhtmltopdf的官方文档（特别是“Footers And Headers”部分）以获取更多关于其内置JavaScript变量和函数的详细信息。当在C#字符串中嵌入HTML和JavaScript时，请注意字符串转义问题。在上面的示例中，使用了@符号创建逐字字符串，以简化多行HTML和JS的编写，并避免了对引号的额外转义。
总结
在NReco.PdfGenerator中定制页码，您可以根据具体需求选择合适的方法：
如果您能够将PDF内容逻辑上拆分为独立的部分，并且只需要为特定部分设置不同的起始页码，那么方法一（GeneratePdfFromFiles结合–page-offset）通常是更简洁、更推荐的选择。如果您需要对单个HTML输入中的页码进行更精细、更复杂的计算和显示控制，或者页码逻辑与页面内容紧密关联，那么方法二（覆盖页脚JavaScript）提供了更大的灵活性，但需要更多的JavaScript编程知识。
无论选择哪种方法，都建议在实际部署前进行充分的测试，以确保页码显示符合预期。
以上就是NReco.PdfGenerator 页码定制指南的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1536475.html
微信扫一扫 
支付宝扫一扫 
