Loading...

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

disable()

Disables the widget on the page.

Example-Disable Signature

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

None

Returns

None

show()

Shows the widget on the form.

Example-Show Signature

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

None

Returns

None

required()

Enables or disables client side validation.

Example-Signature Required

tpc.forms[0].TpcSignature.required();
Parameters

Boolean

Returns

hide()

Hides the widget from the form.

Example-Hide Signature

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

None

Returns

None

set_value()

Sets the value of the widget.

Example-Signature Set Value

tpc.forms[0].TpcSignature.set_value();
Parameters

String

Returns

None

get_element()

Returns the element associated with the widget.

Example-Signature Fetch Element

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

None

Returns

jQuery Object

clear()

Clears the value of the widget.

Example-Clear Signature

tpc.forms[0].TpcSignature.clear();
Parameters

None

Returns

None

get_type()

Returns the widget type.

Example-Signature Fetch Type

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

None

Returns

String

enable()

Enables the widget on the page.

Example-Enable Signature

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

None

Returns

None

get_input()

Returns the input element of the widget.     

Example-Signature Fetch Input Element

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

None

Returns

jQuery Object     

get_canvas()

Returns the canvas element of the widget.

Example-Signature Fetch Canvas

tpc.forms[0].TpcSignature.get_canvas();
Parameters

None

Returns

jQuery Object

get_clearButton()

Returns the clear button element associated with the widget.

Example-Signature Fetch Clear Button

tpc.forms[0].TpcSignature.get_clearButton();
Parameters

None

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Example-Signature Fetch Container Element

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

None

Returns

jQuery Object

get_signaturePad()

Returns the signature pad object associated with the widget.

Example-Signature Fetch Signature Pad

tpc.forms[0].TpcSignature.get_signaturePad();
Parameters

None

Returns

Object

get_value()

Returns the value of the Signature Pad as a DataURL.

Example-Signature Fetch Value

tpc.forms[0].TpcSignature.get_value();
Parameters

None

Returns

String

get_model()

Returns the model object of the widget, which contains a number of useful properties related to the widget.
In the case of the Signature widget, these returned properties and their types are:

  • PenColor: String
  • ReadOnly: Boolean

Example-Signature Fetch Model

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

None

Returns

Object

toggle()

Toggles the visibility of the widget.

Example-Signature TOGGLE

tpc.forms[0].TpcSignature.toggle()
Parameters

None

Returns

None

readonly()

 Sets the widget state to read only.

Example-Signature readonly

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

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

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

true, false

Returns

None