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.

get_container()

Returns the container element of the widget.     

Example-QR Barcode Fetch Container Element

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

None

Returns

JQuery Object     

get_element()

Returns the element of the widget.

Example-QR Barcode Fetch Element

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

None

Returns

JQuery Object

get_input()

Returns the input element of the widget.

Example-QR Barcode Fetch Input Element

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

None

Returns

JQuery Object

get_value()

Returns the value of the chosen attribute of the widget.

Example-QR Barcode Fetch Value

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

None

Returns

String

hide()

Hides the widget from the form.

Example-Hide QR Barcode

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

None

Returns

None

show()

Shows the widget on the form.

Example-Show QR Barcode

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

None

Returns

None

set_background()

Sets the background colour of the widget.

Example-QR Barcode SEt Background Color

tpc.forms[0].TpcQRBarcode.set_background("rgb(255,0,0)");
Parameters

String

Returns

None

set_borderColor()

Sets the border colour of the widget.

Example-QR Barcode Set Border Color

tpc.forms[0].TpcQRBarcode.set_borderColor("rgb(0,255,0)");
Parameters

String

Returns

None

set_borderWidth()

Sets the width of the border associated with the widget.

Example-QR Barcode Set Border Width

tpc.forms[0].TpcQRBarcode.set_borderWidth(10);
Parameters

String

Returns

None

set_color()

Sets the colour of the widget. In the case of the CRM QR Barcode widget, this will set the colour of the barcode itself.

Example-QR Barcode Set Color

tpc.forms[0].TpcQRBarcode.set_color("rgb(0,0,255)"); tpc.forms[0].TpcQRBarcode.set_color("Green");
Parameters

String

Returns

None

set_encoding()

Sets the encoding type for the barcode widget to adhere to.

Example-QR Barcode Set Encoding Type

tpc.forms[0].TpcQRBarcode.set_encoding("ISO_8859_1"); tpc.forms[0].TpcQRBarcode.set_encoding("UTF-8");
Parameters

String

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 for this is 'L'.

Example-QR Barcode Set Error Correction

tpc.forms[0].TpcQRBarcode.set_errorCorrection("L"); tpc.forms[0].TpcQRBarcode.set_errorCorrection("M"); tpc.forms[0].TpcQRBarcode.set_errorCorrection("Q"); tpc.forms[0].TpcQRBarcode.set_errorCorrection("H");
Parameters

String

Returns

None

set_padding()

Sets the padding of the widget.

Example-QR Barcode Set Padding

tpc.forms[0].TpcQRBarcode.set_padding(45);
Parameters

String

Returns

None

set_renderAs()

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

Example-QR Barcode Set Render

tpc.forms[0].TpcQRBarcode.set_renderAs("svg"); tpc.forms[0].TpcQRBarcode.set_renderAs("canvas"); tpc.forms[0].TpcQRBarcode.set_renderAs("vml");
Parameters

String

Returns

None

set_size()

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

Example-QR Barcode Set Size

tpc.forms[0].TpcQRBarcode.set_size(600); tpc.forms[0].TpcQRBarcode.set_size("750");
Parameters

String, Integer

Returns

None

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.

Example-QR Barcode Set Value

tpc.forms[0].TpcQRBarcode.set_value("Ottawa");
Parameters

Returns

toggle()

toggles the visibility of the widget. ​

Example-EXAMPLE-QRCOde TOGGLE

tpc.forms[0].Tpc​QrCode.toggle()
Parameters

None

Returns

None