BeginPageUpdate

Layout da página

Descrição

Inicia uma transação de desenho em lote na página selecionada no momento. As chamadas de desenho seguintes (texto, paths, imagens, anotações) são colocadas em buffer em um único lote e descarregadas no content stream da página quando uma chamada correspondente de EndPageUpdate é feita.

Use isto ao montar uma página complexa a partir de muitas primitivas pequenas de desenho, especialmente ao reabrir uma página salva anteriormente para edição. O agrupamento evita a sobrecarga de serialização do content stream por chamada e mantém o content stream resultante da página compacto e bem formado

Sintaxe

Delphi

Function TPDFlib.BeginPageUpdate: Integer;

ActiveX

Function PDFlib::BeginPageUpdate() As Long

DLL

int DLBeginPageUpdate(int InstanceID);

Valores retornados

0	Failed — no document is open or no page is currently selected.
1	A transação de desenho em lote foi iniciada.

Observações

Toda chamada a BeginPageUpdate deve ser emparelhada com uma chamada a EndPageUpdate na mesma página. O par não é estritamente exigido ao adicionar conteúdo a uma página novinha recém-criada por NewPage; nesse caso a página já está em estado "aberta para escrita". O par é exigido ao reabrir uma página anteriormente fechada (após EndPage ou após carregar o documento) e modificar o conteúdo dela.

Chamadas aninhadas não são suportadas — chame EndPageUpdate antes de abrir outra página para edição.

Exemplo

// 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');

Veja também

EndPageUpdate, SelectPage, NewPage, EndPage