Loading...

Grid 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_type()

Returns the widget type.

Example-Grid Fetch Type

tpc.page.grid.get_type();
Parameters

None

Returns

String

get_windowPlaceholder()

Returns the modal window associated with the widget.

Example-GRID FETCH WINDOW PLACE HOLDER

tpc.page.grid.get_windowPlaceholder()
Parameters

None

Returns

jQuery Object

get_container()

Returns the container element of the widget.     

Example-GRID FETCH CONTAINER ELEMENT

tpc.page.grid.get_container();
Parameters

None

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Example-GRID FETCH ELEMENT

tpc.page.grid.get_element();
Parameters

None

Returns

jQuery Object

hide()

Hides the widget from the page.

Example-HIDE GRID

tpc.page.grid.hide();
Parameters

None

Returns

None

show()

Shows the widget on the page.

Example-SHOW GRID

tpc.page.grid.show();
Parameters

None

Returns

None

toggle()

Toggles the visibility of the widget on the page.

Example-TOGGLE GRID

tpc.page.grid.toggle();
Parameters

None

Returns

None

get_grid()

Returns the Kendo Grid Object.     

Example-GRID FETCH OBJECT

tpc.page.grid.get_grid();
Parameters

None

Returns

Kendo Object: kendo.ui.Grid

get_kendoWindow()

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

Example-Grid Fetch Kendo Window

tpc.page.grid.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-GRID FETCH MODEL

tpc.page.grid.get_model();
Parameters

None

Returns

Object