MPDF项目中使用sethtmlpageheader标签设置HTML页眉详解

什么是sethtmlpageheader标签

sethtmlpageheader是MPDF（版本2.0及以上）提供的一个HTML控制标签，用于在PDF文档中设置已定义的HTML页眉。这个标签允许开发者在文档的不同位置灵活地控制页眉的显示与隐藏。

基本语法

<sethtmlpageheader [name] [page] [value] [show-this-page] />

参数详解

name参数

指定要设置的预定义HTML页眉名称：

• 如果传入空字符串或null，MPDF会尝试使用名为'_default'的默认页眉（如果存在）
• 当value参数设置为'-1'或'off'时，name参数可以省略

page参数

控制页眉应用于哪些页面：

• 'O'或'ODD'：应用于奇数页（双面文档）或所有页（单面文档）
• 'E'或'EVEN'：仅应用于偶数页
• 'ALL'：应用于所有页面
• 默认值：'ODD'

注意：设置空值不会清除页眉，要取消页眉需将value参数设为'-1'或'off'

value参数

控制页眉的启用状态：

• '1'或'ON'：从当前位置开始显示指定页眉
• '-1'或'OFF'：从当前位置停止显示页眉
• 默认值：空值（不改变当前状态）

show-this-page参数

特殊控制参数：

• 设置为"1"或任何正值时，强制在当前页立即显示页眉
• 适用于在新页面添加后才设置页眉的情况
• 默认值：空值

实际应用场景

1. 文档章节切换：在长文档中，不同章节可能需要显示不同的页眉内容

2. 特殊页面处理：封面页、目录页等通常不需要页眉，可以在这些页面前后使用sethtmlpageheader控制

3. 双面打印：为奇数页和偶数页设置不同的页眉样式

使用示例

<!-- 定义页眉 -->
<htmlpageheader name="chapter1">
  <div style="text-align: right">第1章 介绍</div>
</htmlpageheader>

<!-- 启用页眉 -->
<sethtmlpageheader name="chapter1" page="ALL" value="ON" />

文档内容...

<!-- 禁用页眉 -->
<sethtmlpageheader name="chapter1" value="OFF" />

注意事项

1. 使用sethtmlpageheader前，必须先用htmlpageheader标签或DefHTMLHeaderByName()函数定义页眉

2. 在双面文档中，合理设置page参数可以创建专业的外观效果

3. 对于复杂的页眉控制，可以结合使用多个sethtmlpageheader标签

4. 如果页眉设置后没有立即生效，尝试使用show-this-page参数

版本兼容性

该功能自MPDF 2.0版本开始提供，在早期版本中不可用。

通过合理使用sethtmlpageheader标签，开发者可以轻松实现PDF文档中页眉的精细化控制，满足各种复杂的排版需求。