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.

get_type()

Returns the widget type

Parameters

Returns

string

add_click()

Allows to add a click event to the pay button

Parameters

function

Returns

None

remove_click()

Allows to remove a click event from the pay button

Parameters

function

Returns

function

get_container()

Returns the container element of the widget.     

Example-EXAMPLE-PAY BUTTON FETCH CONTAINER ELEMENT

tpc.forms[0].paybutton.get_container();
Parameters

None

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Parameters

None

Returns

jQuery Object

get_input()

Returns the input of the widget.

Example-EXAMPLE- PAY BUTTON FETCH INPUT

tpc.forms[0].paybutton.get_input();
Parameters

None

Returns

jQuery Object

hide()

Hides the widget from the page.

Example-EXAMPLE- HIDE PAY BUTTON

tpc.forms[0].paybutton.hide();
Parameters

None

Returns

None

show()

Shows the widget on the page.

Example-EXAMPLE-SHOW PAY BUTTON

tpc.forms[0].paybutton.show();
Parameters

None

Returns

None

toggle()

toggle the visibility of the widget on the page.

Example-EXAMPLE-TOGGLE PAY BUTTON

tpc.forms[0].paybutton.toggle();
Parameters

None

Returns

None

get_model()

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

Example-EXAMPLE- PAY BUTTON FETCH MODEL

tpc.forms[0].paybutton.get_model();
Parameters

None

Returns

Object

enable()

Enable the widget on the page.

Parameters

None

Returns

None

disable()

disable the widget on the page.

Example-EXAMPLE-DISABLE PAY BUTTON

tpc.forms[0].paybutton.disable();
Parameters

None

Returns

None

enableRedirect()

Enable the redirection on the form submission.

Example-EXAMPLE-ENABLE REDIRECT PAY BUTTON

tpc.forms[0].paybutton.enableRedirect();
Parameters

None

Returns

None

disableRedirect()

Disable the redirection on the form submission.

Example-EXAMPLE- DISABLE REDIRECT PAY BUTTON

tpc.forms[0].paybutton.disableRedirect();
Parameters

None

Returns

None

add_queryParam()

allows you to add querystring parameters. 

Parameters

Name, value

 

Returns

None

set_redirectUrl()

set the redirect URL 

Example-EXAMPLE-SET REDIRECT URL ON PAY BUTTON

tpc.forms[0].payButton.set_redirectUrl('https://www.crmportalconnector.com/');
Parameters

url

Returns

None

get_redirectUrl()

Disable the redirection on the form submission.

Example-EXAMPLE-GET REDIRECT URL PAY BUTTON

tpc.forms[0].paybutton.get_redirectUrl();
Parameters

None

Returns

Url string

get_formAction()

Returns the form actions object of the widget.

Example-EXAMPLE- PAY BUTTON FETCH FORM ACTION

tpc.forms[0].paybutton.get_formAction();
Parameters

​form​Name, responsesSteps

Returns

Object

readonly()

 set the widget state to read only

Example- PayButton- READONLY

//set to true
tpc.forms[0].TpcPaybutton.readonly(true);

//set to false
tpc.forms[0].TpcPaybutton.readonly(false);

//show the read only status
tpc.forms[0].TpcPaybutton.readonly();
Parameters

None

Returns

None