Widget Type:
Page Widgets
TPC Version:
  • 5.2
VideoLogos

The TPC Page Export is a button widget that allows you to download and save a web page (or any section on it) in a printer friendly format of your choosing. We support three file formats: PDF, SVG, and PNG.

TPC page export widget

Configuration

Basic

If you drag and drop the Page Export widget to your page and click on edit, a modal will pop up. This is the designer view and it displays the Basic tab setting. Here you configure basic features to your Export widget, such as naming the button (more on this below).

PDF Options

If you choose a PDF export type, there are additional configurable options you can set on the actual PDF that your users will download upon click such applying a title to the document (more on this below).

Widget Properties

Basic Properties

Button Text

The Button Text property allows you to change the text that appears inside of a button associated with the widget.

File Name

Sets the name of the file when user downloads it

Choose Selector

If you have a specific area on your page that you want the user to download, then you use a CSS selector to target that (e.g., #printTicket or .printTicket), otherwise the entire html doc will get downloaded by default.

Export Type

A dropdown of the formats you can choose to export the desired file.

Title (PDF Options)

Sets the title of the PDF file based on the file in question.

Creator / Producer

Sets who is responsible for the existence of the file e.g., author.

Keywords

Specifies the keywords of the exported PDF file.

Margin

Specifies the margins of the page. Supported units are “mm”, “cm”, “in”, and “pt”. Defaults to 2cm.

Paper Size

Dropdown of common page sizes including in North America and A – C sizes. Defaults to auto which captures the entire content.

Orientation

A dropdown choice between Portrait or Landscape display of file.

Page Break Selector

Specifies where you want a page to break or where you want it to start on a new page. You can target a specific page break by using a CSS selector.

Avoid Links

Selecting this makes the links on any document unclickable. Optionally, you can target a specific link(s) using a CSS selector.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Button Text

The Button Text property allows you to change the text that appears inside of a button associated with the widget.

File Name

Sets the name of the file when user downloads it

Choose Selector

If you have a specific area on your page that you want the user to download, then you use a CSS selector to target that (e.g., #printTicket or .printTicket), otherwise the entire html doc will get downloaded by default.

Export Type

A dropdown of the formats you can choose to export the desired file.

Title (PDF Options)

Sets the title of the PDF file based on the file in question.

Creator / Producer

Sets who is responsible for the existence of the file e.g., author.

Keywords

Specifies the keywords of the exported PDF file.

Margin

Specifies the margins of the page. Supported units are “mm”, “cm”, “in”, and “pt”. Defaults to 2cm.

Paper Size

Dropdown of common page sizes including in North America and A – C sizes. Defaults to auto which captures the entire content.

Orientation

A dropdown choice between Portrait or Landscape display of file.

Page Break Selector

Specifies where you want a page to break or where you want it to start on a new page. You can target a specific page break by using a CSS selector.

Avoid Links

Selecting this makes the links on any document unclickable. Optionally, you can target a specific link(s) using a CSS selector.

API

remove_click(fn)

removes added functionality from the button.

Returns

None

show()

Shows the widget on the page.

Returns

None

disable()

disable the widget on the page.

Returns

None

get_exportButton()

Returns the element of the widget.

Returns

JQuery Object

get_container()

Returns the container element of the widget.

Returns

Jquery Object

get_element()

Returns the element of the widget.

Returns

Jquery Object

toggle()

toggle the visibility of the widget on the page.

Returns

None

hide()

Hides the widget from the page.     

Returns

None

get_model()

Returns the model object of the widget, which contains several useful properties related to the widget.

Returns

Object

enable()

Enable the widget on the page.

Returns

None

add_click(fn)

allows user to add functionality to button on click. 

Returns

Function