SetPageHeaderFooterVariant

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

説明

名前付きで再利用可能なランニングヘッダーおよびフッターセット内に、1 つのバリアントを作成または置換します

構文

Delphi

Function TPDFlib.SetPageHeaderFooterVariant(Const SetName, VariantName,
  Text: WideString; Margin, Height, Opacity: Double; Alignment,
  IsHeader, RichText: Integer): Integer;

ActiveX

Function PDFlib::SetPageHeaderFooterVariant(SetName As String,
  VariantName As String, Text As String, Margin As Double,
  Height As Double, Opacity As Double, Alignment As Long,
  IsHeader As Long, RichText As Long) As Long

DLL

int DLSetPageHeaderFooterVariant(int InstanceID, const wchar_t* SetName,
  const wchar_t* VariantName, const wchar_t* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);
int DLSetPageHeaderFooterVariantA(int InstanceID, const char* SetName,
  const char* VariantName, const char* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);

パラメータ

SetName	1 つのテンプレートセットに属するバリアント間で共有される大文字と小文字を区別しない名前
VariantName	`default`、`first`、`odd`、または `even`。大文字小文字を区別せずに照合されます
Text	選択した各ページごとに個別展開されるテキストまたは HTML テンプレートです。空の値はフォールバックを抑制する明示的な空白バリアントを作成します
Margin	該当するページ端からの非負距離
Height	コンテンツボックスの高さ。0 の場合はプレーンテキスト行または HTML コンテンツを自動的に測定します
Opacity	透明を表す 0 から不透明を表す 1 までの値
Alignment	左は 0、中央は 1、右は 2
IsHeader	ヘッダーには 1、フッターには 0
RichText	`Text` を HTML としてレンダリングする場合は 1、現在の選択フォントと painter 状態を使用する場合は 0

戻り値

バリアントが保存された場合は 1、名前、バリアント、数値、配置、またはフラグが無効な場合は 0 を返します

備考

同じセット名、バリアント名、ヘッダーまたはフッターの役割で後から呼び出すと、既存の定義を置き換える

テンプレートは、<%name%> フィールドや、AddPageHeader と同じアンパサンドフィールドをサポートし、OnCalcVariable で解決されるカスタム変数も使用できます

定義は TPDFlib インスタンスに属し、複数のドキュメントに適用できます

例

PDF.SetPageHeaderFooterVariant('manual', 'first', '', 36, 0, 1, 0, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'odd', 'Chapter — <%PageNo%>', 36, 0, 1, 2, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'even', '<%PageNo%> — Chapter', 36, 0, 1, 0, 1, 0);