AddPageHeaderFooter
ページ操作, 注釈とホットスポットリンク
説明
AddPageHeader と AddPageFooter の背後にある共通プリミティブです。範囲内のすべてのページの上端または下端にランニング行を刻印します。現在選択されているフォントでオーバーレイモードにより描画し、スタンプトークンを各対象ページへ展開し、結果をサブタイプHeaderまたはFooterのPaginationアーティファクトで囲みます
構文
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;パラメータ
| PageRange | ページ範囲式。空文字列を指定するとすべてのページが対象になります |
|---|---|
| Text | 行テキスト。ExpandStampTokens が解釈するトークンは各対象ページに対して展開されます |
| Margin | 上端（ヘッダー）または下端（フッター）から行までの距離（PDFポイント単位） |
| Opacity | 0から1の間のテキスト不透明度。1で完全に不透明に描画されます |
| Alignment | 0はマージン位置で左揃え、1はマージン間で中央揃え、2は右揃えかつ右端からのマージン距離を保持します |
| IsHeader | Trueは上マージンにヘッダーを、Falseは下マージンにフッターを刻印します |
戻り値
行が刻印されたページ数。ドキュメントが選択されていない場合、Textが空の場合、または範囲内のページを1つも選択できなかった場合は0を返します
備考
行は現在のフォントとサイズで計測されるため、先に SelectFont を呼び出してください。IsHeaderがTrueの場合、行は上端からMarginの位置に置かれ、Falseの場合は下端からMarginの位置に、現在のページ高さとテキスト高さに対して計算されて置かれます。呼び出しから戻る際、選択されていたページは復元されます
例
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);