Loading...

SharePoint Document 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.

readonly()

Sets the widget state to read only.

Example-SharePoint ReadOnly

//set to true
tpc.forms[0].SharePointGrid.readonly(true);

//set to false
tpc.forms[0].SharePointGrid.readonly(false);

//show the read only status
tpc.forms[0].SharePointGrid.readonly();
Parameters

true, false

Returns

None

clear()

Clears the value of the widget.

Example-Clear SharePoint

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

None

Returns

None

disable()

Disables the widget on the page.

Example-Disable SharePoint

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

None

Returns

None

set_value()

Sets the text value of the widget.

Example-SharePoint Set Value

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

None

Returns

None

get_kendoUpload()

Returns the Kendo Upload Object associated with the widget.

Example-SharePoint Fetch Kendo Upload

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

None

Returns

Kendo Object: kendo.ui.Upload

get_value()

Returns the value of the widget.

Example-SHAREPOINT FETCH VALUE

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

None

Returns

String

enable()

Enables the widget on the page.

Example-Enable SharePoint

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

None

Returns

None

get_type()

Returns the widget type.

Example-SharePoint Fetch Type

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

None

Returns

String

get_kendoWindow()

Returns the Kendo Window Object associated with the widget.

Example-SharePoint Fetch Kendo Window

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

None

Returns

Kendo Object: Kendo.ui.Window

get_windowPlaceHolder()

Returns the modal window associated with the widget.

Example-SharePoint Fetch Modal

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

None

Returns

jQuery Object

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

Returns

Kendo Object: Kendo.ui.Grid Object

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
  • 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 widget's popup template.

Example-SharePoint Document Grid 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-SHAREPOINT GRID TOGGLE

tpc.forms[0].TpcSharepointGrid.toggle()
Parameters

None

Returns

None