Loading...

Page Export API

Methods
RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

remove_click()

Removes added functionality from the button.

Example-Page Export Remove Click

tpc.page.TpcPageExportModel.remove_click();
Parameters

Function

Returns

None

show()

Shows the widget on the page.

Example-Show Page Export

tpc.page.TpcPageExportModel.show();
Parameters

None

Returns

None

disable()

Disables the widget on the page.

Example-Disable Page Export

tpc.page.TpcPageExportModel.disable();
Parameters

None

Returns

None

get_exportButton()

Returns the element of the widget.

Example-Page Export Fetch Export Button

tpc.page.TpcPageExportModel.get_exportButton();
Parameters

None

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Example-Page Export Fetch Container Element

tpc.page.TpcPageExportModel.get_container();
Parameters

None

Returns

jQuery Object

get_element()

Returns the element of the widget.

Example-Page Export Fetch Element

tpc.page.TpcPageExportModel.get_element();
Parameters

None

Returns

jQuery Object

toggle()

Toggles the visibility of the widget.

Example-Toggle Page Export

tpc.page.TpcPageExportModel.toggle();
Parameters

None

Returns

None

hide()

Hides the widget from the page.     

Example-Hide Page Export

tpc.page.TpcPageExportModel.hide();
Parameters

None

Returns

None

get_model()

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

Example-Page Export Fetch Model

tpc.page.TpcPageExportModel.get_model();
Parameters

None

Returns

Object

enable()

Enable the widget on the page.

Example-Enable Page Export

tpc.page.TpcPageExportModel.enable();
Parameters

None

Returns

None

add_click()

Adds functionality to button on click. 

Example-Page Export Add Click

tpc.page.TpcPageExportModel.add_click();
Parameters

Function 

Returns

Function