Loading...

List View 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_noDataTemplate()

Returns the no data template associated with the widget.

Example-ListView Fetch NoDataTemplate

tpc.page.TpcListview.get_noDataTemplate();
Parameters

None

Returns

jQuery Object

get_type()

Returns the widget type.

Example-ListView Fetch Type

tpc.page.TpcListview.get_type();
Parameters

None

Returns

String

noDataPlaceholder()

Returns the no data place holder associated with the widget.

Example-ListView Fetch NoDataPlaceHolder

tpc.page.TpcListview.noDataPlaceholder();
Parameters

None

Returns

jQuery Object

get_windowPlaceHolder()

Returns the modal window associated with the widget.

Example-ListView Fetch WindowPlaceHolder

tpc.page.TpcListview.get_windowPlaceHolder();
Parameters

None

Returns

jQuery Object

get_pager()

Returns the Kendo Pager Object associated with the widget.

Example-ListView Fetch Pager

tpc.page.TpcListview.get_pager();
Parameters

None

Returns

Kendo Object: kendo.ui.Pager

get_container()

Returns the container element of the widget.     

Example-LISTVIEW FETCH CONTAINER ELEMENT

tpc.page.TpcListview.get_container();
Parameters

None

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Example-LISTVIEW FETCH ELEMENT

tpc.page.TpcListview.get_element();
Parameters

None

Returns

jQuery Object

hide()

Hides the widget from the page.

Example-HIDE LISTVIEW

tpc.page.TpcListview.hide();
Parameters

None

Returns

None

show()

Shows the widget on the page.

Example-SHOW LISTVIEW

tpc.page.TpcListview.show();
Parameters

None

Returns

None

toggle()

Toggles the visibility of the widget.

Example-TOGGLE LISTVIEW

tpc.page.TpcListview.toggle();
Parameters

None

Returns

None

get_listView()

Returns the Kendo ListView Object.     

Example-LISTVIEW FETCH OBJECT

tpc.page.TpcListview.get_listView();
Parameters

None

Returns

Kendo Object: kendo.ui.ListView

get_kendoWindow()

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

Example-ListView Fetch Window

tpc.page.TpcListview.get_kendoWindow();
Parameters

None

Returns

Kendo Object: kendo.ui.Window

get_model()

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

Example-LISTVIEW FETCH MODEL

tpc.page.TpcListview.get_model();
Parameters

None

Returns

Object