layout	title	parent_title	permalink	modification_time
page	Method 4	Headers & Footers	/headers-footers/method-4.html	2015-08-05 11:59:51 +0000

This uses NAMED HTML headers & footers. This is the best way for complex headers/footers with the advantage of HTML code, but you can easily change the headers/footers at any time during the document.

Note that NAMED HTML headers are not specified as ODD or EVEN when they are defined, but only when they are selected.

**Note:** Do not name any header or footer starting with `html_` - This prefix is reserved to identify an HTML header/footer when passing its name in a reference.

**Note:** AddPage(), TOCpagebreak(), <pagebreak> <tocpagebreak> and @page can reference both HTML and NON-HTML headers/footers. When referring to an HTML header/footer you must add the prefix `html_` to distinguish them.

Defining NAMED HTML Headers/Footers

Example #1 - Using PHP

<?php
$mpdf = new \Mpdf\Mpdf();

$mpdf->DefHTMLHeaderByName(
  'Chapter2Header',
  '<div style="text-align: right; border-bottom: 1px solid #000000; 
  font-weight: bold; font-size: 10pt;">Chapter 2</div>'
);

$mpdf->DefHTMLFooterByName(
  'Chapter2Footer',
  '<div style="text-align: right; font-weight: bold; font-size: 8pt; 
  font-style: italic;">Chapter 2 Footer</div>'
);

Example #2 - Using Custom HTML tags

<?php
$mpdf = new \Mpdf\Mpdf();

$html = '
<htmlpageheader name="myHeader1">
    <div style="text-align: right>My document</div>
</htmlpageheader>

<htmlpageheader name="myHeader2">
    <div style="border-bottom: 1px solid #000000; font-weight: bold;  font-size: 10pt;">
        My document
    </div>
</htmlpageheader>

<htmlpagefooter name="myFooter1">
    <table width="100%">
        <tr>
            <td width="33%">{DATE j-m-Y}</td>
            <td width="33%" align="center">{PAGENO}/{nbpg}</td>
            <td width="33%" style="text-align: right; ">My document</td>
        </tr>
    </table>
</htmlpagefooter>

<htmlpagefooter name="myFooter2">
    <table width="100%">
        <tr>
            <td width="33%">My document</td>
            <td width="33%" align="center">{PAGENO}/{nbpg}</td>
            <td width="33%" style="text-align: right;">{DATE j-m-Y}</td>
        </tr>
    </table>
</htmlpagefooter>';

Referencing a Header/Footer by NAME

Once you have defined NAMED HTML headers/footers for your document, you can reference them using:

Methods for HTML headers/footers only - Recommended when setting the first page header/footer at the start of a document (although they can also be used to change headers/footers during the document).

<a href="{{ "/reference/mpdf-functions/sethtmlheaderbyname.html" | prepend: site.baseurl }}">SetHTMLHeaderByName() - see Example #3
<a href="{{ "/reference/mpdf-functions/sethtmlfooterbyname.html" | prepend: site.baseurl }}">SetHTMLFooterByName() - see Example #3
<a href="{{ "/paging/using-page.html" | prepend: site.baseurl }}">@page - see Example #5
<<a href="{{ "/reference/html-control-tags/sethtmlpageheader.html" | prepend: site.baseurl }}">sethtmlpageheader> - see Example #4
<<a href="{{ "/reference/html-control-tags/sethtmlpagefooter.html" | prepend: site.baseurl }}">sethtmlpagefooter> - see Example#4

Methods to access any headers/footers (HTML or NON-HTML ) - Recommended when changing header/footer during the document.

<a href="{{ "/reference/mpdf-functions/addpage.html" | prepend: site.baseurl }}">AddPage() - see Example #6
<<a href="{{ "/reference/html-control-tags/pagebreak.html" | prepend: site.baseurl }}">pagebreak> - see Example #7
<a href="{{ "/paging/using-page.html" | prepend: site.baseurl }}">@page - see Example #5
<a href="{{ "/reference/mpdf-functions/tocpagebreak.html" | prepend: site.baseurl }}">TOCpagebreak() - see Example #8
<<a href="{{ "/reference/html-control-tags/tocpagebreak.html" | prepend: site.baseurl }}">tocpagebreak> - see Example #9

Setting a named HTML header at the start of a document

When using a NAMED header on the first page, remember that mPDF writes the header as the first page is started. This is usually when you first use WriteHTML() which automatically triggers an AddPage().

Example #3 - SetHTMLHeaderByName()

<?php
$mpdf = new \Mpdf\Mpdf();

// Define an HTML header named 'MyHeader1' here (as Example #1)
$mpdf->SetHTMLHeaderByName('MyHeader1');

$mpdf->WriteHTML('Document text');

$mpdf->Output();

In this example using custom HTML tags to set the HTML header, notice that <sethtmlpageheader> has show-this-page = "1". This is because as soon as you call WriteHTML(), mPDF has added the first page, so this fixes the problem by forcing the header to show on the first page:

Example #4 - <sethtmlpageheader>

<?php
$mpdf = new \Mpdf\Mpdf();

$html = '
<htmlpageheader name="MyHeader1">
    <div style="text-align: right">My document</div>
</htmlpageheader>

<htmlpagefooter name="MyFooter1">
    <table width="100%">
        <tr>
            <td width="33%"><span style="font-weight: bold; font-style: italic;">{DATE j-m-Y}</span></td>
            <td width="33%" align="center" style="font-weight: bold; font-style: italic;">{PAGENO}/{nbpg}</td>
            <td width="33%" style="text-align: right; ">My document</td>
        </tr>
    </table>
</htmlpagefooter>

<sethtmlpageheader name="MyHeader1" value="on" show-this-page="1" />
<sethtmlpagefooter name="MyFooter1" value="on" />

<div>Start of the document ... and all the rest</div>';

$mpdf->WriteHTML($html);

$mpdf->Output();

Example #5 - @page

<?php
$mpdf = new \Mpdf\Mpdf();

$html = '
<html>
<head>
<style>
    @page {
      size: auto;
      odd-header-name: html_MyHeader1;
      odd-footer-name: html_MyFooter1;
    }

    @page chapter2 {
        odd-header-name: html_MyHeader2;
        odd-footer-name: html_MyFooter2;
    }

    @page noheader {
        odd-header-name: _blank;
        odd-footer-name: _blank;
    }

    div.chapter2 {
        page-break-before: always;
        page: chapter2;
    }

    div.noheader {
        page-break-before: always;
        page: noheader;
    }
</style>
</head>
<body>
    <htmlpageheader name="MyHeader1">
        <div style="text-align: right; border-bottom: 1px solid #000000; font-weight: bold; font-size: 10pt;">My document</div>
    </htmlpageheader>

    <htmlpageheader name="MyHeader2">
        <div style="border-bottom: 1px solid #000000; font-weight: bold;  font-size: 10pt;">My document</div>
    </htmlpageheader>

    <htmlpagefooter name="MyFooter1">
        <table width="100%" style="vertical-align: bottom; font-family: serif; font-size: 8pt; color: #000000; font-weight: bold; font-style: italic;">
            <tr>
                <td width="33%"><span style="font-weight: bold; font-style: italic;">{DATE j-m-Y}</span></td>
                <td width="33%" align="center" style="font-weight: bold; font-style: italic;">{PAGENO}/{nbpg}</td>
                <td width="33%" style="text-align: right; ">My document</td>
            </tr>
        </table>
    </htmlpagefooter>

    <htmlpagefooter name="MyFooter2">
        <table width="100%" style="vertical-align: bottom; font-family: serif; font-size: 8pt; color: #000000; font-weight: bold; font-style: italic;">
            <tr>
                <td width="33%"><span style="font-weight: bold; font-style: italic;">My document</span></td>
                <td width="33%" align="center" style="font-weight: bold; font-style: italic;">{PAGENO}/{nbpg}</td>
                <td width="33%" style="text-align: right; ">{DATE j-m-Y}</td>
            </tr>
        </table>
    </htmlpagefooter>

    <div>Here is the text of the first chapter</div>
    <div class="chapter2">Text of Chapter 2</div>

    <div class="noheader">No-Header page</div>
</body>
</html>';

$mpdf->WriteHTML($html);

$mpdf->Output();

Selecting a named header during the document

Example #6 - AddPage()

<?php
$mpdf->WriteHTML('Document text');

// In a SINGLE-SIDED document, the 'ODD' values set the default for all pages.
$mpdf->AddPage(
    '','','','','','','','','','','', 
    'html_MyHeader2', '', 'html_MyFooter2', '', 1, 0, 1, 0
);
$mpdf->WriteHTML('Document text');

// Turn Headers and Footers off
$mpdf->AddPage('','','','','','','','','','','', '', '', '', '', -1, 0, -1, 0);
$mpdf->WriteHTML('Document text with No Headers/Footers');

Example #7

<?php
$html = '
<p>Document text</p>
<p>Text of Chapter 2</p>

<!-- TO TURN HEADER/FOOTER OFF FOR A NEW PAGE -->
<pagebreak odd-header-value="off" odd-footer-value="off" />

<p>No-Header page/p>';

$mpdf->WriteHTML($html);

<?php
$mpdf = new \Mpdf\Mpdf();

// Define HTML headers here named 'MyHeader1', 'MyTOCHeader', 'MyTOCFooter', 
// 'MyHeader2', 'MyFooter2' (as Example #1)
$mpdf->SetHTMLHeaderByName('MyHeader1');

$mpdf->WriteHTML('Introduction of document...');

$mpdf->TOCpagebreak (
  '', '', '', '', '', '', '', '', '', '', '', '', 
  'html_MyTOCHeader', '', 'html_MyTOCFooter', '', 1, 0, 1, 0, 
  '', '', '', '', '', '', '', '', '', '', '', '', '', 
  'html_MyHeader2', '', 'html_MyFooter2', '', 1, 0,  1, 0
);

$mpdf->WriteHTML('Main part of document...');

$mpdf->Output();

Example #9 - <tocpagebreak>

<?php
$html = "
<!-- Define HTML headers etc  here named 'MyHeader1', 'MyTOCHeader', 'MyTOCFooter', 
     'MyHeader2', 'MyFooter2' (as Example #2) -->

<p>Introduction: Here starts the document</p>

<tocpagebreak toc-odd-header-name='html_MyTOCHeader' toc-odd-header-value=\"1\" 
    toc-odd-footer-name='html_MyTOCFooter' toc-odd-footer-value=\"1\"
    odd-header-name='html_MyHeader2' odd-header-value=\"1\"  
    odd-footer-name='html_MyFooter2' odd-footer-value=\"1\" />

Text of Chapter 2...";

$mpdf->WriteHTML($html);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

method-4.md

method-4.md

Defining NAMED HTML Headers/Footers

Example #1 - Using PHP

Example #2 - Using Custom HTML tags

Referencing a Header/Footer by NAME

Setting a named HTML header at the start of a document

Example #3 - SetHTMLHeaderByName()

Example #4 - <sethtmlpageheader>

Example #5 - @page

Selecting a named header during the document

Example #6 - AddPage()

Example #7

Table of Contents

Example #8 - TOCpagebreak()

Example #9 - <tocpagebreak>

See Also

Files

method-4.md

Latest commit

History

method-4.md

File metadata and controls

Defining NAMED HTML Headers/Footers

Example #1 - Using PHP

Example #2 - Using Custom HTML tags

Referencing a Header/Footer by NAME

Setting a named HTML header at the start of a document

Example #3 - SetHTMLHeaderByName()

Example #4 - <sethtmlpageheader>

Example #5 - @page

Selecting a named header during the document

Example #6 - AddPage()

Example #7

Table of Contents

Example #8 - TOCpagebreak()

Example #9 - <tocpagebreak>

See Also