BeginDeferredPageLayer

Page layout, Vector graphics, Content streams

Description

Starts recording drawing operations into a page-sized deferred layer associated with the selected page

Syntax

Delphi

Function TPDFlib.BeginDeferredPageLayer(ZIndex: Integer): Integer;

ActiveX

Function PDFlib::BeginDeferredPageLayer(ZIndex As Long) As Long

DLL

int DLBeginDeferredPageLayer(int InstanceID, int ZIndex);

Parameters

ZIndex	Signed stacking value used when the queued layers are composed

Return values

Returns 1 when recording starts, or 0 when no page is selected, another deferred layer, Form XObject, or tiling pattern is active, the page dimensions are invalid, the queued layers belong to another page, or the 1024-layer limit was reached

Remarks

Negative z-index values are placed beneath the page content that existed before composition, while zero and positive values are placed above it

Layers with the same z-index retain their original recording order

The target page is tracked by its indirect object identity, so moving that page does not detach its queued layers

Call EndDeferredPageLayer after drawing the layer

Example

if PDF.BeginDeferredPageLayer(-100)= 1 then
begin
  PDF.SetFillColor(0.95, 0.95, 0.95);
  PDF.DrawBox(0, 0, PDF.PageWidth, PDF.PageHeight, 1);
  PDF.EndDeferredPageLayer;
end;