THotPDF.ViewerPreferences

THotPDF

 

Top  Previous  Next

Determines the viewer application preferences written to the PDF document.

 

type

   THPDFViewerPreference = (vpHideToolbar, vpHideMenubar, vpHideWindowUI, vpFitWindow, vpCenterWindow, vpDisplayDocTitle, vpDirection, vpNonFullScreenPageMode, vpPrintScaling, vpDuplex, vpPickTrayByPDFSize, vpNumCopies, vpPrintArea, vpPrintClip);

   THPDFViewerPreferences = set of THPDFViewerPreference;

 

Delphi syntax:

property ViewerPreferences: THPDFViewerPreferences;

 

C++ syntax:

__property THPDFViewerPreferences ViewerPreferences;

 

Description

Viewer preferences control how the document is presented on screen and how a viewer may initialize printing behavior. Some values are simple flags and some require the related THotPDF properties to be set as well.

 

Value                Meaning


vpHideToolbar                Specifying whether to hide the viewer application's tool bars when the document is active.

vpHideMenubar        Specifying whether to hide the viewer application's menu bar when the document is active.

vpHideWindowUI        Specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls),

                                 leaving only the document's contents displayed.

vpFitWindow                Specifying whether to resize the document's window to fit the size of the first displayed page.

vpCenterWindow        Specifying whether to position the document's window in the center of the screen.

vpDisplayDocTitle      Display the document Title entry instead of the file name in the viewer window caption.

vpDirection            Write the document reading direction. Use the THotPDF.Direction property to choose LeftToRight or RightToLeft.

vpNonFullScreenPageMode  Defines the page mode to use after leaving full-screen mode. Use the THotPDF.NonFullScreenPageMode property.

vpPrintScaling        Controls the default print scaling mode. Use the THotPDF.PrintScaling property.

vpDuplex              Writes the duplex printing preference. Use the THotPDF.Duplex property.

vpPickTrayByPDFSize  Specifies whether the viewer should select the printer tray by PDF page size.

vpNumCopies            Writes the suggested print copy count. Use the THotPDF.NumCopies property.

vpPrintArea            Defines the page boundary used for print rendering. Use the THotPDF.PrintArea property.

vpPrintClip            Defines the page boundary used for print clipping. Use the THotPDF.PrintClip property.

 

Related Properties

Direction, NonFullScreenPageMode, PrintScaling, Duplex, NumCopies, PrintArea, PrintClip, and InitialZoom.

 

Notes

Viewer preferences are recommendations to the PDF viewer. Support varies by application. Adobe Reader and Acrobat usually provide the most complete behavior.