Loading...

Submit Button

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.1 +
VideoLogos

TPC Submit Button allows the user to submit the form and redirect the browser with query string parameters. The widget is configurable to add new query string parameters with values defined in the form fields and pass the existing parameters to the redirection page.
It also has the functionality to act as a multi page step button.

2017-03-13_9-40-07

Configuration

Basic

Make sure you have a CRM Form Configuration and a TPC Form Layout attached and configured or else you won't see any fields for the widget. Once you add all the field to the form to configure TPC Submit Button, Drag and drop the Submit button to the form body and click on the edit.

From the designer, you can set the submit button text, enable re-direction to a different page, enable multi page form and set the previous button text.

submit-button

Query and Fields

In this tab you can select which form filed add to the query string and specific query string values to pass in to the next page. 

submit-button-1

Widget Properties

Basic Properties

ButtonText

ButtonText property will enables you to set the user facing text of the button. 

Enable Redirect on Submit

Redirect to a page when this property is enabled and set to true and page selected.

PreviousButtonText

PreviousButtonText property will enables you to set the user facing text of the previous button.

PreviousButtonClasses

PreviousButtonClasses property enable you to set the classes for the previous button. By default, it set to bootstrap button link classes. (btn btn-link).

ButtonClass

ButtonClass property enables you to set the classes for the button. By default, it set to default bootstrap button classes.(btn btn-default).

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

ButtonText

ButtonText property will enables you to set the user facing text of the button. 

Enable Redirect on Submit

Redirect to a page when this property is enabled and set to true and page selected.

PreviousButtonText

PreviousButtonText property will enables you to set the user facing text of the previous button.

PreviousButtonClasses

PreviousButtonClasses property enable you to set the classes for the previous button. By default, it set to bootstrap button link classes. (btn btn-link).

ButtonClass

ButtonClass property enables you to set the classes for the button. By default, it set to default bootstrap button classes.(btn btn-default).

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

API

set_previousPageUrl()

Sets the previous page URL.

Returns

None

get_previousPageUrl()

Returns the previous page URL.

Returns

URL String

enablePreviousRedirect()

Enables redirection on the previous button click.

Returns

None

remove_click()

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

Returns

None

get_type()

Returns the widget type.

Returns

String

disablePreviousRedirect()

Disables redirection on the previous button click.

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.

Returns

None

get_container()

Returns the container element of the widget.     

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_input()

Returns the input of the widget.

Returns

jQuery Object

hide()

Hides the widget from the form.

Returns

None

show()

Shows the widget on the form.

Returns

None

toggle()

Toggles the visibility of the widget on the form.

Returns

None

get_model()

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

Returns

Object

enable()

Enables the widget on the form.

Returns

None

disable()

Disables the widget on the form.

Returns

None

enableRedirect()

Enables redirection on the form submission.

Returns

None

disableRedirect()

Disables redirection on the form submission.

Returns

None

add_queryParam()

Allows the addition of query string parameters. 

Returns

None

set_redirectUrl()

Sets the redirect URL. 

Returns

None

get_redirectUrl()

Returns the redirect URL.

Returns

URL String

get_formAction()

Returns the form actions object of the widget.

Returns

Object

readonly()

 Sets the widget state to read only.

Returns

None     

Full API With Examples

Examples of Submit Button Configuration