WebForm.generatePdf

Generates a PDF from one or more pages, with options to display to the user and save the generated file. Generates a PDF based on the options specified in the options parameter.

Any page created in the Form Designer can be output either to a web browser or to a PDF or to both of these. This means that the same page designer is used to create both web and print pages. There is no explicit declaration that a particular page is a print page; instead any page can be output as a PDF by invoking this method.

The following options are available (see PdfOptions):

• display the PDF to the user (default true)
• save the PDF as a file on the server (default false)
• display the PDF as a popup (default true)
• display all HTML form input elements (textfields, textareas) as display only. This is useful when the length of data in the element may exceed the specified display size and the generated PDF should automatically expand to display all data. (default true)
• which pages to include in the PDF (default is the current page)
• the file path when the PDF is saved (See PdfOptions for the default)
• the popup window name (no default)

In addition to the options available via this method, there are a number of other page design considerations that affect the appearance of a generated PDF e.g. how scrollable controls such as tables expand to display all content, how page breaks are handled, margins, headers and footers, page size and orientation, page numbering, print page styling etc. The Page Designer allows configuration of a number of properties for individual controls which address these considerations.

Further documentation.

Javascript example:

 var opts = new PdfOptions();
 opts.display = true;
 opts.save = true;
 opts.popup = true;
 opts.reportMode = true;
 opts.filePath = "C:/temp/pdf123.pdf";
 opts.popupWindowName = "pdf1";
 opts.pages = [pages.PAGE_2, pages.PAGE_4];
 var fileName = form.generatePdf(opts);