[e2pdf-download]

Shortcode is applied to generate and output the PDF download link button.

Basic Attributes #

  • Default shortcode can be used inside elements that support the "auto" dataset.
    • id - The ID of the E2pdf Template to use.
  • Shortcode to output PDF download link for the "static" PDF from the server.
    • pdf - Full path to static PDF.
    • dataset - The ID of the "dataset" to use for which it must be generated PDF. A dynamic dataset will be used if not set, depending on where the shortcode is placed.

      It's required to be set if shortcode placed at:
      • PHP functions
      • Elements that do not support "auto" dataset
    • dataset2 - The ID of the 2nd "dataset" to use for which it must be generated PDF.

      Can be used with:
      • Extension: Formidable Forms, Item: Merged Items
    • user_id - Overwrite defined User ID for [e2pdf-user] shortcode.
    • arg1, arg2, arg3, ... - Add custom values to be accessible inside PDF.

      • Usage inside E2Pdf Template:
    • output - Output of the shortcode.

      • url - Outputs the PDF download link for the PDF.
      • url_raw - Outputs the raw PDF download link for the PDF.
      • url_encode - Outputs the encoded PDF download link for the PDF.

Style Attributes #

    • class - Additional classes to add to generated PDF download link.
    • button_title - Overwrite the "Button Title" option setting inside E2Pdf Template.

PDF Settings Attributes #

    • name - Overwrite the "PDF Name" option setting inside E2Pdf Template.
    • password - Overwrite the "PDF Password" option setting inside E2Pdf Template.
    • format - Overwrite the "Format" option setting inside E2Pdf Template.

      • pdf
      • jpg
    • flatten - Overwrite the "Flatten" (read-only) option setting inside E2Pdf Template.

      • 0 - No flatten (editable fields)
      • 1 - Flatten (readonly fields)
      • 2 - Full flatten (PDF pages as images)
    • inline - Overwrite the "Inline" option setting inside E2Pdf Template.
    • auto - Overwrite the "Auto Download" option setting inside E2Pdf Template.

    • iframe_download - Force "Auto Download" via Iframe. Required when used with Ajax responses.