PDF：ヘッダーとフッター

ドキュメントをレンダリングする際にたいへんよく行うタスクは、ページヘッダーやページフッターに静的テキスト（ドキュメントタイトルなど）やページ番号を追加してカスタマイズすることです。そのために、PdfDocumentにはこれらのセクションを宣言的に構成する方法が用意されています。

PdfRunningTitleは、ページのヘッダーとフッターを表すクラスです。このクラスにはdeclarativeプロパティがあり、このプロパティにはさらに次のプロパティが含まれます。

• text：欄外見出しのテキストを決定します。
• brush：テキストの塗りつぶしに使用されるブラシを決定します。
• font：テキストのフォントを決定します。

これらのプロパティは、PdfDocumentクラスインスタンスの作成中に定義できます。ドキュメントのレンダリングが完了すると、ページの反復処理が行われ、各ページに指定されたブラシとフォントで指定されたテキストが追加されます。

たとえば、次のコードは、各ページのヘッダーに赤色で塗りつぶされた「Title」という文字列を追加することを定義します。

import * as wjPdf from '@mescius/wijmo.pdf';

var doc = new wjPdf.PdfDocument({
    header: {
        declarative: {
            text: "Title",
            brush: "#ff0000"
        }
    }
});

テキストには、最大3つのタブ文字（"\t"）を入れてテキストをいくつかの部分に分割し、各部分をページ領域内で左揃え、中央揃え、および右揃えに整列できます。"&[Page]"と"&[Pages]"の2つのマクロがサポートされます。前者は現在のページインデックスを示し、後者はページ数を示します。

次に例を示します。

• "&[Page]"：現在のページインデックスを左揃えで追加します。
• "\t&[Page]/&[Pages]"："X/Y"形式（"X"は現在のページインデックス、"Y"はページ数）のページ番号を中央揃えで追加します。
• "\tTitle\t&[Page]"："Title"文字列を中央揃えで追加し、現在のページインデックスを右揃えで追加します。

フォントとブラシの使用の詳細については、フォントとグラフィックスを参照してください。