Loading...

Form Configuration 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.

get_logicalName()

Returns the logical name of widget that is currently set up.

Example-Form Configuration Fetch Logical Name

tpc.forms[0].TpcFormConfiguration.get_logicalName();
Parameters

None

Returns

String

get_recordId()

Returns the record ID of the widget.

Example-Form Configuration Fetch RecordId

tpc.forms[0].TpcFormConfiguration.get_recordId();
Parameters

None

Returns

String

get_container()

Returns the container element of the widget.

Example-Form Configuration Fetch Container Element

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

None

Returns

jQuery Object

get_type()

Returns the widget type.

Example-Form Configuration Fetch Type

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

None

Returns

String

get_model()

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

Example-Form Configuration Fetch Model

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

None

Returns

Object

get_value()

Returns the value of the widget.

Example-Form Configuration Fetch Value

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

None

Returns

String