BeginPageUpdate

ページレイアウト

説明

現在選択されているページでバッチ描画トランザクションを開始します。後続の描画呼び出し(テキスト、パス、画像、注釈)は単一バッチにバッファリングされ、対応する EndPageUpdate 呼び出し時にページのコンテンツストリームへフラッシュされます

多数の小さな描画プリミティブから複雑なページを組み立てる場合、特に以前保存したページを編集用に再度開く場合に使用します。バッチ処理によって呼び出しごとのコンテンツストリームシリアル化オーバーヘッドを避け、生成されるページコンテンツストリームをコンパクトで整形式に保ちます

構文

Delphi

Function TPDFlib.BeginPageUpdate: Integer;

ActiveX

Function PDFlib::BeginPageUpdate() As Long

DLL

int DLBeginPageUpdate(int InstanceID);

戻り値

0失敗 — 文書が開かれていないか、現在ページが選択されていない
1バッチ描画トランザクションが開始されました

備考

各 BeginPageUpdate 呼び出しは、同じページ上の 1 回の EndPageUpdate 呼び出しと対にする必要があります。NewPage で作成したばかりの新しいページにコンテンツを追加する場合、この対は厳密には必要ありません。その場合、ページはすでに "open for writing" 状態です。以前に閉じたページを再び開いてコンテンツを変更する場合、この対は必須です(EndPage の後、または文書の読み込み後)

呼び出しのネストには対応していません — 別のページを編集用に開く前に EndPageUpdate を呼び出します

例

// Add a stamp on an existing page of a loaded document
PDF.LoadFromFile('contract.pdf', '');
PDF.SelectPage(1);
PDF.BeginPageUpdate;
  PDF.SetTextColor(0.8, 0, 0);
  PDF.SetFontSize(48);
  PDF.PrintText(150, 400, 'DRAFT');
PDF.EndPageUpdate;
PDF.SaveToFile('contract-stamped.pdf');

関連項目

EndPageUpdate、SelectPage、NewPage、EndPage