Loading...

Workflow 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_model()

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

Example-Workflow Fetch Model

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

None

Returns

Object

get_value()

Returns the file name of a selected file.

Example-Workflow Fetch Value

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

None

Returns

String

toggle()

Toggles the visibility of the widget.

Example-Toggle Workflow

tpc.forms[0].TpcWorkflow.toggle();
Parameters

None

Returns

None

get_element()

Returns the element of the widget.

Example-Workflow Fetch Element

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

None

Returns

jQuery Object

set_value()

Sets the value of the widget.

Example-Workflow Set Value

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

Returns

None

hide()

Hides the widget from the form.

Example-Hide Workflow

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

None

Returns

None

show()

Shows the widget on the form.

Example-Show Workflow

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

None

Returns

None

get_input()

Returns the input element of the widget.     

Example-Workflow Fetch Input Element

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

None

Returns

jQuery Object

get_type()

Returns the widget type.

Example-Workflow Fetch Type

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

None

Returns

String

get_container()

Returns the container element of the widget.

Example-Workflow Fetch Container Element

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

None

Returns

jQuery Object