Loading...

Scheduler 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.

show()

Shows the widget on the page.

Example-SHOW SCHEDULER

tpc.page.scheduler.show();
Parameters

None

Returns

None

get_element()

Returns the element of the widget.

Example-SCHEDULER FETCH ELEMENT

tpc.page.scheduler.get_element();
Parameters

None

Returns

jQuery Object

get_windowPlaceHolder()

Returns the modal window associated with the widget.

Example-Scheduler Fetch Modal

tpc.page.scheduler.get_windowPlaceHolder();
Parameters

None

Returns

jQuery Object

get_model()

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

Example-SCHEDULER FETCH MODEL

tpc.page.scheduler.get_model();
Parameters

None

Returns

Object

get_kendoWindow()

Returns the Kendo Window Object of the widget (add/edit set to popup window).     

Example-Scheduler Fetch Kendo Window

tpc.page.scheduler.get_kendoWindow();
Parameters

Kendo Object: kendo.ui.Window

Returns

None

get_scheduler()

Returns the Kendo Scheduler Object.     

Example-SCHEDULER FETCH OBJECT

tpc.page.scheduler.get_scheduler();
Parameters

None

Returns

Kendo Object: kendo.ui.Grid

get_container()

Returns the container element of the widget.     

Example-SCHEDULER FETCH CONTAINER ELEMENT

tpc.page.scheduler.get_container();
Parameters

None

Returns

jQuery Object     

get_type()

Returns the widget type.

Example-Scheduler Fetch Type

tpc.page.scheduler.get_type();
Parameters

None

Returns

string

toggle()

Toggles the visibility of the widget on the page.

Example-TOGGLE SCHEDULER

tpc.page.scheduler.toggle();
Parameters

None

Returns

None

hide()

Hides the widget from the page.

Example-HIDE SCHEDULER

tpc.page.scheduler.hide();
Parameters

None

Returns

None