Loading...

Submit 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.

set_previousPageUrl()

Sets the previous page URL.

Example-Submit Button Set Previous URL

tpc.forms[0].TpcSubmitButton.set_previousPageUrl();
Parameters

URL String

Returns

None

get_previousPageUrl()

Returns the previous page URL.

Example-Submit Button Fetch Previous URL

tpc.forms[0].TpcSubmitButton.get_previousPageUrl();
Parameters

None

Returns

URL String

enablePreviousRedirect()

Enables redirection on the previous button click.

Example-Submit Button Enable Previous Redirect

tpc.forms[0].TpcSubmitButton.enablePreviousRedirect();
Parameters

None

Returns

None

remove_click()

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

Example-Submit Button Remove Click

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

Function

Returns

None

get_type()

Returns the widget type.

Example-Submit Button Fetch Type

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

None

Returns

String

disablePreviousRedirect()

Disables redirection on the previous button click.

Example-Submit Button Disable Previous Redirect

tpc.forms[0].TpcSubmitButton.disablePreviousRedirect();
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 this keyword) will be set to the widget instance.

Example-Submit Button Add Click

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

Function

Returns

None

get_container()

Returns the container element of the widget.     

Example-SUBMIT BUTTON FETCH CONTAINER ELEMENT

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

None

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Example-SUBMIT BUTTON FETCH ELEMENT

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

None

Returns

jQuery Object

get_input()

Returns the input of the widget.

Example-SUBMIT BUTTON FETCH INPUT

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

None

Returns

jQuery Object

hide()

Hides the widget from the form.

Example-HIDE SUBMIT BUTTON

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

None

Returns

None

show()

Shows the widget on the form.

Example-SHOW SUBMIT BUTTON

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

None

Returns

None

toggle()

Toggles the visibility of the widget on the form.

Example-TOGGLE SUBMIT BUTTON

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

None

Returns

None

get_model()

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

Example-SUBMIT BUTTON FETCH MODEL

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

None

Returns

Object

enable()

Enables the widget on the form.

Example-ENABLE SUBMIT BUTTON

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

None

Returns

None

disable()

Disables the widget on the form.

Example-DISABLE SUBMIT BUTTON

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

None

Returns

None

enableRedirect()

Enables redirection on the form submission.

Example-SUBMIT BUTTON ENABLE REDIRECT

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

None

Returns

None

disableRedirect()

Disables redirection on the form submission.

Example-SUBMIT BUTTON DISABLE REDIRECT

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

None

Returns

None

add_queryParam()

Allows the addition of query string parameters. 

Example-SUBMIT BUTTON ADD QUERY PARAMETERS

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

Name, Value

Returns

None

set_redirectUrl()

Sets the redirect URL. 

Example-SUBMIT BUTTON SET REDIRECT URL

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

URL String

Returns

None

get_redirectUrl()

Returns the redirect URL.

Example-SUBMIT BUTTON FETCH REDIRECT URL

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

None

Returns

URL String

get_formAction()

Returns the form actions object of the widget.

Example- SUBMIT BUTTON FETCH FORM ACTION

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

FormName, responsesSteps

Returns

Object

readonly()

 Sets the widget state to read only.

Example-SUBMIT BUTTON READ ONLY

//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