AddPageHeader

ページ操作, 注釈とホットスポットリンク

説明

選択されたドキュメントの1つ以上のページにランニングヘッダー行を刻印します。テキストは現在選択されているフォントでオーバーレイモードにより描画され、<%PageNo%> などのスタンプトークンは行が計測される前に各対象ページへ展開されます。刻印された行はサブタイプHeaderのPaginationアーティファクトで囲まれるため、タグ付きPDFリーダーはこれを繰り返しコンテンツではなくページ装飾として扱います

構文

Delphi

Function TPDFlib.AddPageHeader(Const PageRange, Text: WideString;
  Margin, Opacity: Double; Alignment: Integer): Integer;

パラメータ

PageRange	ページ範囲式。空文字列を指定するとすべてのページが対象になります
Text	ヘッダーテキスト。ExpandStampTokens が解釈するトークンは各対象ページに対して展開されます
Margin	ページ上端からヘッダー行までの距離（PDFポイント単位）
Opacity	0から1の間のテキスト不透明度。1で完全に不透明に描画されます
Alignment	0はマージン位置で左揃え、1はマージン間で中央揃え、2は右揃えかつ右端からのマージン距離を保持します

戻り値

ヘッダーが刻印されたページ数。ドキュメントが選択されていない場合、Textが空の場合、または範囲内のページを1つも選択できなかった場合は0を返します

備考

行は現在のフォントとサイズで計測されるため、先に SelectFont を呼び出してください。オーバーレイの下ではページ上の既存コンテンツがそのまま見えます。呼び出しから戻る際、選択されていたページは復元されます

HTMLコンテンツに対応した先頭ページ、奇数ページ、偶数ページのヘッダーロールについては ApplyPageHeaderFooterSet を参照してください

例

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
  28, 1, 1);