Loading...

Signature

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
signaturelogo
The Signature Widget allows you to sign a form with a virtual signature.

A submitted signature will be attached to the Notes section of a record. It can also be configured to be attached as a SharePoint Document for a record.

SignatureExample

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.

Drag and drop the Signature Field from the Portal Connector tools into the TPC Form Layout and click edit to display the properties prompt.

The Title will allow you to set the label for the widget.

The File Name will allow you to specify the name of a signature image. Please note that you will have to include the “.png” extension.

The File Location will allow you to specify where a signature will be saved. Available options include saving a signature as a Note attached to a record or as a SharePoint Document attached to a record.

The Read Only will not allow the user to interact with the widget when checked. 
The Required will not allow the user to submit the form until they've signed the widget.
signature-instruction-1

Appearance

You can specify the Pen Color of a widget using the color palette, dropdown list, or by entering a hexadecimal value.

You have the option of setting a Height in pixels.

signature-instruction-2

Widget Properties

Basic Properties

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Signature File Name

The Signature File Name property allows you to set the filename of a saved signature image.

Signature File Location

The Signature File Location property allows you to specify where a signature image will be saved. Available options include: Notes and SharePoint.

Notes will save the signature to a record as a note. The name of the note can be specified with the Signature File Name property.

For SharePoint, a new document is created and attached to the record. The name of the document can be specified with the Signature File Name property.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

Required Field

The Required Field checkbox will not allow a user to successfully submit the form until there is data within it. 

Upon selecting the checkbox, you will be prompted to enter an error message for invalid input.

ClientSideRequired

Allows you to enable or disable "required" from client side  

Pen Color

The Pen Color property will determine the color of the brush for the CRM Signature widget, and will provide a color picker to determine which color for the widget to use. You can also use a hexadecimal value to set the color of the brush.

Height - Signature widget

The Height text box allows you to adjust the height of the widget. In this case, height is measured in pixels (px). Some widgets, including the CRM Notes widget, will apply a scrollbar to the list of notes if it exceeds its given height.

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. 

IsHidden

Allows you to hide the widget when this property is set to true

Hide Title

You can hide the title by setting the property value to true

LabelPosition

The LabelPosition advanced property specifies where the label of a widget will appear. By default, the label will appear on top of the widget. Applicable options include: Top and left. The content of the label is controlled by the Title property. The default value for this is 'Top'.

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.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Signature File Name

The Signature File Name property allows you to set the filename of a saved signature image.

Signature File Location

The Signature File Location property allows you to specify where a signature image will be saved. Available options include: Notes and SharePoint.

Notes will save the signature to a record as a note. The name of the note can be specified with the Signature File Name property.

For SharePoint, a new document is created and attached to the record. The name of the document can be specified with the Signature File Name property.

Read Only

The Read Only checkbox will not allow the user to interact with the widget when checked.

Required Field

The Required Field checkbox will not allow a user to successfully submit the form until there is data within it. 

Upon selecting the checkbox, you will be prompted to enter an error message for invalid input.

ClientSideRequired

Allows you to enable or disable "required" from client side  

Pen Color

The Pen Color property will determine the color of the brush for the CRM Signature widget, and will provide a color picker to determine which color for the widget to use. You can also use a hexadecimal value to set the color of the brush.

Height - Signature widget

The Height text box allows you to adjust the height of the widget. In this case, height is measured in pixels (px). Some widgets, including the CRM Notes widget, will apply a scrollbar to the list of notes if it exceeds its given height.

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. 

IsHidden

Allows you to hide the widget when this property is set to true

Hide Title

You can hide the title by setting the property value to true

LabelPosition

The LabelPosition advanced property specifies where the label of a widget will appear. By default, the label will appear on top of the widget. Applicable options include: Top and left. The content of the label is controlled by the Title property. The default value for this is 'Top'.

API

disable()

Disables the widget on the page.

Returns

None

show()

Shows the widget on the form.

Returns

None

required()

Enables or disables client side validation.

Returns

hide()

Hides the widget from the form.

Returns

None

set_value()

Sets the value of the widget.

Returns

None

get_element()

Returns the element associated with the widget.

Returns

jQuery Object

clear()

Clears the value of the widget.

Returns

None

get_type()

Returns the widget type.

Returns

String

enable()

Enables the widget on the page.

Returns

None

get_input()

Returns the input element of the widget.     

Returns

jQuery Object     

get_canvas()

Returns the canvas element of the widget.

Returns

jQuery Object

get_clearButton()

Returns the clear button element associated with the widget.

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Returns

jQuery Object

get_signaturePad()

Returns the signature pad object associated with the widget.

Returns

Object

get_value()

Returns the value of the Signature Pad as a DataURL.

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

Returns

Object

toggle()

Toggles the visibility of the widget.

Returns

None

readonly()

 Sets the widget state to read only.

Returns

None

Full API With Examples