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.

set_previousPageUrl()

set the previous page URL 

Parameters

url

Returns

None

get_previousPageUrl()

get the previous Page Url

Parameters

None

Returns

Url string

enablePreviousRedirect()

Enable the redirection on the previous button click

Parameters

None

Returns

None

remove_click()

Removes any delegate hooked up to the add_valueChanged() event.

Parameters

Function

Returns

None

get_type()

Returns the widget type

Parameters

None

Returns

String

disablePreviousRedirect()

Disable the redirection on the previous button click.

Parameters

None

Returns

None

add_click()

Fired when the value of the widget is clicked by the user. 

The event handler function context (Available via the this keyword) will be set to the widget instance.

Parameters

Function

Returns

get_container()

Returns the container element of the widget.     

Example-EXAMPLE-SUBMITBUTTON FETCH CONTAINER ELEMENT

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

None

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Example-EXAMPLE- SUBMITBUTTON FETCH ELEMENT

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

None

Returns

jQuery Object

get_input()

Returns the input of the widget.

Example-EXAMPLE- SUBMITBUTTON FETCH INPUT

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

None

Returns

jQuery Object

hide()

Hides the widget from the page.

Example-EXAMPLE- HIDE SUBMITBUTTON

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

None

Returns

None

show()

Shows the widget on the page.

Example-EXAMPLE-SHOW SUBMITBUTTON

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

None

Returns

None

toggle()

toggle the visibility of the widget on the page.

Example-EXAMPLE-TOGGLE SUBMITBUTTON

tpc.forms[0].submitbutton.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- SUBMITBUTTON FETCH MODEL

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

None

Returns

Object

enable()

Enable the widget on the page.

Example-EXAMPLE-ENABLE SUBMITBUTTON

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

None

Returns

None

disable()

disable the widget on the page.

Example-EXAMPLE-DISABLE SUBMITBUTTON

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

None

Returns

None

enableRedirect()

Enable the redirection on the form submission.

Example-EXAMPLE-ENABLE REDIRECT SUBMITBUTTON

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

None

Returns

None

disableRedirect()

Disable the redirection on the form submission.

Example-EXAMPLE- DISABLE REDIRECT SUBMITBUTTON

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

None

Returns

None

add_queryParam()

allows you to add query string parameters. 

Example-EXAMPLE-ADD QUERY PARAMEETERS SUBMITBUTTON

tpc.forms[0].submitbutton.add_queryParam(‘companyName’,”pavlis.com”);
Parameters

Name, value

Returns

None

set_redirectUrl()

​set the redirect URL 

Example-EXAMPLE-SET REDIRECT URL ON SUBMITBUTTON

tpc.forms[0].submitbutton.set_redirectUrl(“https://www.crmportalconnector.com/”);
Parameters

url

Returns

None

get_redirectUrl()

get the redirect Url

Example-EXAMPLE-GET REDIRECT URL SUBMITBUTTON

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

None

Returns

Url string

get_formAction()

Returns the form actions object of the widget.

Example-EXAMPLE- SUBMITBUTTON FETCH FORM ACTION

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

Form​Name, responsesSteps

Returns

Object

readonly()

 set the widget state to read only

Example-SUBMIT BUTTON- READONLY

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

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

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

true, false

Returns

None