<pdflink>

This tag renders as a link or button the user can click to download a PDF version of the page. The following advanced attributes are available for use:

<pdflink> attributes
Attribute Allowed Values Requirements Description

attachment-fields

Text

Optional

Defines a list of WebEOC Nexus attachment fields, contents of which will be appended to a generated PDF document. List of fields has to be separated with comma attachments-fields="attachmentfield1, attachmentfield2" and <attachment name="attachmentfield1"> element for each field in the list has to be present in the view. Attachments will be appended to PDF document in the order they are listed attachments-fields attribute. Supported attachment types are:

  • BMP

  • GIF

  • JPEG

  • PDF

  • PNG

  • TIFF

This functionality is limited only to a details view.

child-attachments-fields

Text

Optional

Defines a list of WebEOC Nexus child records attachment fields. When specified, attachments from child records will be appended to the generated PDF.

To be able to append attachments to the PDF document:

  • The <relatedlist /> has to be configured and present in the view.

  • Only those attachments which are specified in the <relatedlist /> may be appended to the PDF document.

  • child-attachments-table has to be specified and match <relatedlist /> table.

child-attachments-table

Text

Optional

Defines a list of WebEOC Nexus child records attachment fields. When specified, attachments from child records will be appended to the generated PDF.

To be able to append attachments to the PDF document:

  • The <relatedlist /> has to be configured and present in the view.

  • Only those attachments which are specified in the <relatedlist /> may be appended to the PDF document.

  • child-attachments-table has to be specified and match <relatedlist /> table.

board

boardname

Optional

Name of the board that contains the view.

enablejs

(false|true)false

Implied

Any JavaScript that runs on page load will run when true.

type

(button|link)link

Implied

How the tag is rendered.

enablemediaquery

(false|true)

Optional

Enables media query rule when rendering PDF.

enablewebkit

Text

Optional

Enables web kit rendering engine – handles html5, css3, and font awesome icons – for PDF documents.

This is obsolete.

filename

Text

Optional

The name of the PDF file to be generated. If no file name then the default is "boarddata.pdf"

footerfloatx

Float

Optional

Starting x coordinate where the text renders in the footer.

footerfloaty

Float

Optional

Starting y coordinate where the text renders in the footer.

footerfontsize

Float

Optional

Font size of the footer text, measured in em font size units. If no font size is specified, the default font size is 1 em.

footertext

Text

Optional

Text of the footer. If no text is present, the footer is not shown. It is possible to show the current page number in addition to the total page number by using _currentpage and _pagecount respectively.

See also, footerhtml.

headerfloatx

Float

Optional

Starting x coordinate where the text renders in the header.

headerfloaty

Float

Optional

Starting y coordinate where the text renders in the header.

headerfontsize

Float

Optional

Font size of the header text, measured in em font size units. If no font size is specified, the default font size is 1 em.

headerfootertextalign

(left|center|right|justify|default)left

Implied

Alignment of the text in the PDF's header and footer.

headertext

Text

Optional

Text of the header.

manual

(false|true)

Optional

Defines if PDF printing will be invoked manually, by triggering wrapped BoardScript.StartPDFGeneration(), or natively through the ExpertPdfJSObj.startConversion() function.

To have the map printed to PDF via the <embedmap> tag, the value must be true [WebEOC Nexuswith other manual, custom printing invoke tags (for example, if the board view printing is based on a manual flag, then the <embedtag> tag will break that functionality when printing to PDF).

orientation

(portrait|landscape)portrait

Implied

PDF orientation. If not specified, the PDF's orientation is portrait.

type

(button|link)link

Implied

How the tag is rendered.

view

%viewname

Optional

Name of the view (if different from the current view). If a board is not specified, WebEOC Nexus assumes the current board.

*

*

Optional

Passes any HTML attribute–except onclick and href–through to the rendered tag.

engine

Text

Optional

The PDF engine that is used. Two engines are available:

  • Default

  • Blink: Provides support for newer browser PDF rendering.

  • The remaining features in this table require the Blink PDF engine to be used.

  • Self-hosted clients must have the Google Chrome browser installed on their web server because Blink requires Chrome to create PDF files. If errors occur after installing Chrome, use the BlinkEnginePath setting in the web.config file to specify the path to the Chrome executable.

    Example:

    BlinkEnginePath="C:/Program Files/Google/Chrome/Application"

footerhtml

Text

Optional

An encoded HTML string that specifies the footer contents.

  • To use this attribute, the Blink PDF engine must be used.

  • This string overrides footertext. _currentpage and _pagecount are not supported. To use page numbers, use headertext and footertext.

headerhtml

Text

Optional

An encoded HTML string that specifies the header contents. Use True to enable it.

  • To use this attribute, the Blink PDF engine must be used.

  • This string overrides headertext. _currentpage and _pagecount are not supported. To use page numbers, use headertext and footertext.

fitwidth

Boolean

Optional

Scales the HTML content to fit the width of the page. If the HTML content is wider than the page, it is resized to fit within the page margin. Use True to enable it.

To use this attribute, the Blink PDF engine must be used.

fitheight

Boolean

Optional

Scales the HTML content to fit the width of the page. If the HTML content is wider than the page, it is resized to fit within the page margin. Use True to enable it.

To use this attribute, the Blink PDF engine must be used.

optimize memory

Boolean

Optional

Aids in lowering the memory usage by optimizing the way HTML content is processed and rendered. This setting is useful for large documents or environment with limited resources.

To use this attribute, the Blink PDF engine must be used.

conversiondelay

Text

Optional

Adds additional time, in seconds, before Async items load.

To use this attribute, the Blink PDF engine must be used.

Examples

Copy Code
<pdflink type="button" orientation="landscape" 
headerfootertextalign="center" headertext="For Official Use Only" 
headerfontsize="12" footertext="Page _currentpage of _pagecount" 
footerfontsize="12">Print PDF<pdflink>

The PDF generated by the <pdflink> tag respects CSS page break properties.

Copy Code
<table style="page-break-after:always">...</table>
<tr style="page-break-before:always">...</tr>
<td style="page-break-inside:avoid">...</td>