ApplyPageHeaderFooterSet

ページレイアウト、ページネーション、HTML テキスト

説明

先頭ページと物理ページの奇偶選択を使用して、名前付きヘッダーおよびフッターセットをページ範囲に適用します

構文

Delphi

Function TPDFlib.ApplyPageHeaderFooterSet(Const SetName,
  PageRange: WideString): Integer;

ActiveX

Function PDFlib::ApplyPageHeaderFooterSet(SetName As String,
  PageRange As String) As Long

DLL

int DLApplyPageHeaderFooterSet(int InstanceID, const wchar_t* SetName,
  const wchar_t* PageRange);
int DLApplyPageHeaderFooterSetA(int InstanceID, const char* SetName,
  const char* PageRange);

パラメータ

SetNameSetPageHeaderFooterVariant で以前登録された、大文字と小文字を区別しない名前
PageRangeページ範囲式。空文字列を指定するとすべてのページが対象になります

戻り値

描画された空でないヘッダーおよびフッター要素の数を返します。セットや範囲に適用可能なコンテンツがないか、現在の API スコープがページを変更できない場合は 0

備考

各ヘッダーおよびフッターロールで、範囲が返す最初のページは定義済みなら first を使用します。以降のページは物理ページ番号に従って odd または even を使用し、固有のバリアントがない場合は default にフォールバックします

明示的に定義された空のバリアントは何も描画せずフォールバックを防ぐため、空白の先頭ページに対応できます

各テンプレートは測定前に対象ページに対して展開され、HTML バリアントでは自動高さ計算に展開済みマークアップを使用します

生成されたコンテンツはページネーションアーティファクトとしてマークされ、呼び出し元が選択したページ、フォント、ペインター状態、およびカーニング設定が復元されます

例

PDF.SetPageHeaderFooterVariant('manual', 'default',
  '<b>Manual</b> — <%PageNo%>/<%TotalPages%>', 36, 0, 0.8, 2, 0, 1);
if PDF.ApplyPageHeaderFooterSet('manual', '3-20')= 0 then
  HandleLayoutError;