THPDFPage.UserHeight

THPDFPage

ページの高さを作図単位（1/THotPDF.Resolution インチ）で返します。

Delphi 構文:

property UserHeight: Single; // read-only

C++ 構文:

__property float UserHeight = {read=GetUserHeight};

説明

Y 座標、マージン、フォントサイズ、TextWidth と TextHeight の戻り値は、いずれも 1/Resolution インチです。Height はページの高さをポイントで保持し、設定にもポイントを受け取るため、Resolution が 72 以外のときは作図に使う座標と一致しません。ページの高さを作図座標と比較したり組み合わせたりするとき、たとえば下マージンの端を求めるとき、ブロックを中央揃えにするとき、コンテンツを次のページへ移すタイミングを判定するときは、UserHeight を読み取ってください

既定の Resolution 72 では、UserHeight は Height と等しくなります。Width と Height の設定でページサイズを決めた場合、Resolution が何であってもポイント単位で作図されるため、このときも UserHeight は Height と等しくなります。

program FooterLine;
{$APPTYPE CONSOLE}
uses
  SysUtils,
  HPDFDoc;

var
  HPDF: THotPDF;

begin
  HPDF:= THotPDF.Create(nil);
  try
    HPDF.FileName:= 'FooterLine.pdf';
    HPDF.Resolution:= 144;                    // Coordinates in 1/144 inch
    HPDF.BeginDoc;
    HPDF.CurrentPage.SetFont('Arial', [], 20); // 10 pt
    // UserHeight is 1684 on an A4 page here; Height stays 842 points
    HPDF.CurrentPage.TextOut(144, HPDF.CurrentPage.UserHeight- 144, 0,
      'Footer one inch above the bottom edge');
    HPDF.EndDoc;
  finally
    HPDF.Free;
  end;
end.

See also: Height, UserWidth, THotPDF.Resolution