Loading...

QR Code

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
qrlogo
The QR Code widget will generate a QR barcode from CRM Attribute data.

QRExample

Configuration

Basic

Make sure you have a Form with Form Configuration and a TPC Form Layout already attached.

Drag and drop the QR Code widget from the Portal Connector tools into the body of your form and click edit to display the properties prompt.

The Attribute dropdown list allows you to select an attribute for the widget. This would provide the data to produce the QR barcode. 

The Encoding Type allows you to specify a barcode symbology for the QR barcode to adhere to. You can read more about QR barcode symbology here and here.
qrcode-instructions-1

Widget Properties

Basic Properties

Attribute

The Attribute drop down list will allow you to change the data field that this widget will save the user’s input to (For example, a CRM Text Field with an Attribute of Account Name will save its input to the Account Name data field).

Encoding Type

The symbology for the the barcode to adhere to.

There are a number of encoding types available.

Find out more about Encodings.

Hidden

The Hidden checkbox will hide the widget from the page when checked.

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. 

Background

The Background advanced property allows you to set the background colour of a widget.

BorderColor

The BorderColor advanced property allows you to set the border color of a widget.

BorderWidth

The BorderWidth advanced property allows you to set the border width of a widget.

Color

The Color advanced property allows you to set the font color of a widget.

Padding

The Padding advanced property allows you to set the padding of a widget.

Size

you can define the size of the QR code. 

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.

Attribute

The Attribute drop down list will allow you to change the data field that this widget will save the user’s input to (For example, a CRM Text Field with an Attribute of Account Name will save its input to the Account Name data field).

Encoding Type

The symbology for the the barcode to adhere to.

There are a number of encoding types available.

Find out more about Encodings.

Hidden

The Hidden checkbox will hide the widget from the page when checked.

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. 

Background

The Background advanced property allows you to set the background colour of a widget.

BorderColor

The BorderColor advanced property allows you to set the border color of a widget.

BorderWidth

The BorderWidth advanced property allows you to set the border width of a widget.

Color

The Color advanced property allows you to set the font color of a widget.

Padding

The Padding advanced property allows you to set the padding of a widget.

Size

you can define the size of the QR code. 

API

clear()

Clears the value of the widget.

Returns

None

get_type()

Returns the widget type.

Returns

String

readonly()

Sets the widget state to read only.

Returns

None

enable()

Enables the widget on the page.

Returns

None

disable()

Disables the widget on the page.

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 element of the widget.

Returns

jQuery Object

get_value()

Returns the value of the chosen attribute of the widget.

Returns

String

hide()

Hides the widget from the form.

Returns

None

show()

Shows the widget on the form.

Returns

None

set_background()

Sets the background colour of the widget.

Returns

String

set_borderColor()

Sets the border colour of the widget.

Returns

String

set_borderWidth()

Sets the width of the border associated with the widget.

Returns

String

set_color()

Sets the colour of the widget. In the case of the QR Code widget, this will set the colour of the QR Code itself.

Returns

String

set_encoding()

Sets the encoding type for the QR Code widget to adhere to.

Returns

None

set_errorCorrection()

Sets the error correction level for the widget. More information on error correction levels can be found here. The default value is 'L'.

Returns

String

set_padding()

Sets the padding of the widget.

Returns

String

set_renderAs()

Sets the preferred rendering engine. The default value for this is 'svg'. More information on this method can be found here.

Returns

String

set_size()

Sets the size of the widget. The default value is '150'.

Returns

String, Integer

set_value()

Sets the value of the widget. In the case of the QR Barcode widget, a new barcode will be rendered based on this value.

Returns

None

toggle()

Toggles the visibility of the widget. 

Returns

None

Full API With Examples

Examples of QR Code Configuration