THotPDF.InitialZoom Property

 

THotPDF.InitialZoom

THotPDF

 

Top  Previous  Next

Controls the initial page display zoom written to the document's OpenAction entry. The value is honored by PDF readers when the file is opened.

 

type

THPDFInitialZoom = (

     FitNone, FitPage, FitWidth, FitHeight, FitBox,

     FitBoxWidth, FitBoxHeight,

     Zoom50, Zoom75, Zoom100, Zoom125, Zoom150, Zoom200);

 

Delphi syntax:

property InitialZoom: THPDFInitialZoom;

 

C++ syntax:

__property THPDFInitialZoom InitialZoom;

 

Description

Use InitialZoom to set the page-display mode that the document opens with. HotPDF writes the value into the document's /OpenAction entry as one of the standard PDF view destinations defined in the PDF specification (Fit, FitH, FitV, FitR, FitB, FitBH, FitBV, or XYZ).

Since HotPDF v2.3.11 the default value is FitHeight (PDF /FitV destination), so generated documents open with each page fitted to the viewer's window height. Set InitialZoom to FitNone to omit the OpenAction entry and let the viewer fall back to its own default zoom.

 

Value              PDF destination    Meaning


FitNone           (none)            No special zoom; let the viewer use its own default.

FitPage           /Fit              Fit the entire page inside the window.

FitWidth          /FitH             Fit page width to the window.

FitHeight         /FitV             Fit page height to the window. (default)

FitBox            /FitR or /FitB     Fit the bounding box of the page contents to the window.

FitBoxWidth      /FitBH          Fit the bounding box width to the window.

FitBoxHeight     /FitBV          Fit the bounding box height to the window.

Zoom50            /XYZ null null 0.5       Open the page at 50% scale.

Zoom75            /XYZ null null 0.75      Open the page at 75% scale.

Zoom100          /XYZ null null 1.0       Open the page at 100% (actual size).

Zoom125          /XYZ null null 1.25      Open the page at 125% scale.

Zoom150          /XYZ null null 1.5       Open the page at 150% scale.

Zoom200          /XYZ null null 2.0       Open the page at 200% scale.

 

For a higher-level overview of how InitialZoom interacts with the PDF viewer-preferences dictionary, see the ViewerPreferences Complete Reference.

 

Code Example

HPDF := THotPDF.Create( nil );
try
  HPDF.FileName  := 'c:\Output.pdf';
  HPDF.InitialZoom := FitWidth;       // Open with page width fitted to window
  HPDF.BeginDoc;
  HPDF.CurrentPage.TextOut( 100, 100, 0, 'Hello World!' );
  HPDF.EndDoc;
finally
  HPDF.Free;
end;