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_container()

Returns the container element of the widget.     

Example-SharePoint Fetch Container Element

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

None

Returns

JQuery Object     

get_element()

Returns the element of the widget.

Example-SharePoint Fetch Element

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

None

Returns

JQuery Object

get_grid()

Returns the kendo grid object associated with the widget.

Example-SharePoint Fetch Grid

tpc.forms[0].SharePointGrid.get_grid();
Parameters

None

get_model()

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

In the case of the ​SharePoint Document Grid widget, these returned properties and their types are:

  • AllowAddingDocuments: Boolean
  • AllowDeletingDocuments: Boolean
  • AllowDownloadingDocuments: Boolean
  • AllowEditingDocuments: Boolean
  • AllowedExtensions: String
  • ControlDataId: String
  • CurrentRecordId: String
  • CurrentRecordLogicalName: String
  • GridSettings: Object
    • AddRecordButtonText: String
    • ExcelExportAllPages: Boolean
    • ExcelExportFileName: String
    • ExcelExportFilterable: Boolean
    • Filterable: Boolean
    • Groupable: Boolean
    • PageSize: Integer
    • Pageable: Boolean
    • PageableAllowRefresh: Boolean
    • PageableButtonCount: Integer
    • PageablePageSizes: String
    • ReorderableColumns: Boolean
    • ResizableColumns: Boolean
    • ServerFiltering: Boolean
    • ServerGrouping: Boolean
    • ServerSorting: Boolean
    • ShowColumnMenu: Boolean
    • Sortable: Boolean
    • VirtualScrolling: Boolean
  • MaxFileSizeBytes: Integer

 

Example-SharePoint Fetch Model

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

None

Returns

Object     

get_popupTemplate()

Returns the script tag associated with the widgets' popup template.

Example-Barcode Fetch Popup Template

tpc.forms[0].SharePointGrid.get_popupTemplate();
Parameters

None     

Returns

JQuery Object

hide()

Hides the widget from the form.

Example-Hide SharePoint Grid

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

None

Returns

None

show()

Shows the widget on the form.

Example-Show SharePoint Grid

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

None

Returns

None

toggle()

toggles the visibility of the widget. ​

Example-EXAMPLE-SharepointGrid TOGGLE

tpc.forms[0].Tpc​SharepointGrid.toggle()
Parameters

None

Returns

None