Loading...

Pay Button 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.

get_type()

Returns the widget type.

Example-Pay Button Fetch Type

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

None

Returns

String

add_click()

Allows the addition of a click event to the pay button.

Example-Pay Button Add Click

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

Function

Returns

None

remove_click()

Allows the removal of a click event from the pay button.

Example-Pay Button Remove Click

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

Function

Returns

Function

get_container()

Returns the container element of the widget.     

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.

Example-Pay Button Fetch Element

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

None

Returns

jQuery Object

get_input()

Returns the input of the widget.

Example-PAY BUTTON FETCH INPUT

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

None

Returns

jQuery Object

hide()

Hides the widget from the form.

Example-HIDE PAY BUTTON

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

None

Returns

None

show()

Shows the widget on the form.

Example-SHOW PAY BUTTON

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

None

Returns

None

toggle()

Toggles the visibility of the widget.

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-PAY BUTTON FETCH MODEL

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

None

Returns

Object

enable()

Enables the widget on the form.

Example-Enable Pay Button

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

None

Returns

None

disable()

Disables the widget on the form.

Example-DISABLE PAY BUTTON

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

None

Returns

None

enableRedirect()

Enables redirection on the form submission.

Example-ENABLE REDIRECT PAY BUTTON

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

None

Returns

None

disableRedirect()

Disables redirection on the form submission.

Example-PAY BUTTON DISABLE REDIRECT

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

None

Returns

None

add_queryParam()

Allows the addition of querystring parameters.

Example-Pay Button Add Query Parameters

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

Name, value

Returns

None

set_redirectUrl()

Sets the redirect URL.

Example-PAY BUTTON SET REDIRECT URL

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

URL String

Returns

None

get_redirectUrl()

Returns the redirect URL.

Example-PAY BUTTON GET REDIRECT URL

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

None

Returns

URL String

get_formAction()

Returns the form actions object of the widget.

Example-PAY BUTTON FETCH FORM ACTION

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

formName, responsesSteps

Returns

Object

readonly()

Sets the widget state to read only.

Example- Pay Button 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