PdfOptions

This class supplies a number of options used to generate a PDF. It is used as an argument for WebForm#generatePdf(PdfOptions).

Further documentation.

PdfOptions Functions

setDisplay PdfOptions.setDisplay( display ) Sets the display option.
isDisplay PdfOptions.isDisplay( ) Returns the display option.
setFilePath PdfOptions.setFilePath( filePath ) Sets the file path used to save the document on the server when option save is set to true.
getFilePath PdfOptions.getFilePath( ) Returns the file path where the PDF will be saved.
setPages PdfOptions.setPages( pages ) Sets the pages to be included in the PDF.
getPages PdfOptions.getPages( ) Returns the pages to be printed.
setPopup PdfOptions.setPopup( popup ) When the display option is set to true, this option controls whether or not the PDF is displayed to the user in a popup window.
isPopup PdfOptions.isPopup( ) Returns the popup option.
setPopupWindowName PdfOptions.setPopupWindowName( popupWindowName ) When the popup option is set to true, this method can be used to specify a named window.
getPopupWindowName PdfOptions.getPopupWindowName( ) Returns the popup window name.
setReportMode PdfOptions.setReportMode( reportMode ) Sets the report mode option.
isReportMode PdfOptions.isReportMode( ) Returns the report mode option.
setSave PdfOptions.setSave( save ) Sets the save option.
isSave PdfOptions.isSave( ) Returns the save option.