Loading...

SharePoint Document Grid

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
sharepointlogo

The SharePoint Document form widget allows the integration of Microsoft’s SharePoint for use in Portal Connector forms. It displays documents and their details in a grid view and allows adding, editing, and deleting of any SharePoint document. Please note that an enabled SharePoint CRM account is required.

Attachment of a new file creates a new CRM SharePoint Document.

Re-attaching a different file to the same document overwrites the file contents but not the title.

Configuration

Basic

Please ensure that your CRM account allows SharePoint. 

Make sure you have a CRM Form Configuration and a TPC Form Layout already attached and configured or else you won't see any fields for the widget.

Drag and drop the SharePoint Grid from The Portal Connector widget list into the body of your form and click edit to display the properties prompt.

The Title will allow you to set the label for the control.

The Basic settings contain a number of options, allowing you to determine if a user is allowed to add, edit, download or delete SharePoint documents to/from the grid.

sharepoint-instruction-1

Documents

The Docs Per Page allows you to specify how many documents will appear per page. If the total amount exceeds this limit, then paging will be applied.

The Prefix Filter allows you to filter documents by their prefix. You can choose to include or exclude them with the option of hiding the prefix.

sharepoint-instruction-2

Validation

The Allowed Extensions textfield allows you to specify which files are allowed to be uploaded to a document. Each file extension type should be separated with a semicolon. 

For example default is: ".doc;.docx;.txt;.rtf;.pdf;.zip;.rar;.png;.jpg;.bmp;.jpeg".

sharepoint-instruction-3

Widget Properties

Basic Properties

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Allow Adding Documents

The Allow Adding Documents property will allow users to add new documents to the SharePoint grid..

Allow Downloading Documents

The Allow Downloading Documents checkbox will allow users to download any existing SharePoint document they would like from the widget.

Allow Editing Documents

The Allow Editing Documents property will allow users to edit any existing documents on the SharePoint grid.

Allow Deleting Documents

The Allow Deleting Notes property allows you to delete any document attached to the SharePoint grid.

Allowed Extensions

The Allowed Extensions text box will only allow specific file types to be uploaded to a widget. Extensions are separated by a semicolon (.doc;.txt;.jpg;.png).

GridSettings

GridSettings can be found under Advanced > Model > GridSettings
 

Property

Description

AddRecordButtonClass

The CSS class of the Add Record Button.

AddRecordButtonText

The button text of the Add Record Button.

AddRecordIconClass

The CSS class of the Add Record Icon.

AddRecordImageClass

The class of the Add Recode Image.

 

DeleteRecordButtonClass

The CSS class of the Delete Record Button.

DeleteRecordButtonText

The button text of the Delete Record Button.

DeleteRecordColumnHeaderText

The column header text of the Delete Record Column Header.

DeleteRecordColumnWidth

The width of the Delete Record Colum.

DeleteRecordIconClass

The class of the Delete Record Icon.

DeleteRecordImageClass

The class of the Delete Record Image.

EditRecordButtonClass

The class of the Edit Record Button.

EditRecordButtonText

The text of the Edit Record Button.

EditRecordColumnHeaderText

The column header text of the Edit Record Column Header.

EditRecordColumnWidth

The width of the Edit Record Colum.

EditRecordIconClass

The CSS class of the Edit Record Icon.

EditRecordImageClass

The CSS class of the Edit Record Image.

ExcelExportAllPages

If set to true the grid will export all pages of data.

ExcelExportFileName

Specifies the file name of the exported Excel file.

ExcelExportFilterable

Enables or disables column filtering in the Excel file.

Filterable

If set to true the user can filter the data source using the grid filter menu.

GridHeight

The height of the grid. Numeric values are treated as pixels.

Groupable

If set to true the column will be groupable.

Pageable

If set to true the grid will display a pager.

PageableAllowRefresh

If set to true the pager will display the refresh button. Clicking the refresh button will refresh the grid.

PageableButtonCount

The maximum number of buttons displayed in the numeric pager. The pager will display ellipsis (...) if there are more pages than the specified number.

PageablePageSizes

The number of data items which will be displayed in the grid. Default values are 10,25,50,100, all.

PageSize

The number of data items per page. The property has no default value. That is why to use paging, make sure somepageSizevalue is set.

ReorderableColumns

If set to true the user could reorder the columns by dragging their header cells.

ResizableColumns

If set to true, users can resize columns by dragging the edges (resize handles) of their header cells.

Scrollable

If set to true the grid will display a scrollbar when the total row height (or width) exceeds the grid height (or width).

ServerFiltering

If set to true, the data source will leave the filtering implementation to the remote service.

ServerGrouping

If set to true, the data source will leave the grouping implementation to the remote service.

ServerPaging

If set to true, the data source will leave the data item paging implementation to the remote service.

ServerSorting

If set to true the data source will leave the grouping implementation to the remote service.

ShowColumnMenu

If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled).

Sortable

If set to true the user could sort the grid by clicking the column header cells.

VirtualScrolling

If set to true the grid will always display a single page of data. Scrolling would just change the data which is currently displayed.

GridEvents

GridEvents can be found under Advanced > Model > GridSettings > GridEvents

GridEvents Allows you to add events handlers to the Grid. This is a list of the different events available. You pass in a function name to handle the desired event. More documentation of the Kendo grid events can be found in here: https://docs.telerik.com/kendo-ui/api/javascript/ui/grid#events 

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

HidePrefix

The HidePrefix advanced property determines whether the prefix of a note should be hidden or not. By default this is set to false.

IncludePrefix

The IncludePrefix advanced property determines if the prefix of a note should be visible or not. By default this is set to false.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

IsHidden

Allows you to hide the widget when this property is set to true

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Allow Adding Documents

The Allow Adding Documents property will allow users to add new documents to the SharePoint grid..

Allow Downloading Documents

The Allow Downloading Documents checkbox will allow users to download any existing SharePoint document they would like from the widget.

Allow Editing Documents

The Allow Editing Documents property will allow users to edit any existing documents on the SharePoint grid.

Allow Deleting Documents

The Allow Deleting Notes property allows you to delete any document attached to the SharePoint grid.

Allowed Extensions

The Allowed Extensions text box will only allow specific file types to be uploaded to a widget. Extensions are separated by a semicolon (.doc;.txt;.jpg;.png).

GridSettings

GridSettings can be found under Advanced > Model > GridSettings
 

Property

Description

AddRecordButtonClass

The CSS class of the Add Record Button.

AddRecordButtonText

The button text of the Add Record Button.

AddRecordIconClass

The CSS class of the Add Record Icon.

AddRecordImageClass

The class of the Add Recode Image.

 

DeleteRecordButtonClass

The CSS class of the Delete Record Button.

DeleteRecordButtonText

The button text of the Delete Record Button.

DeleteRecordColumnHeaderText

The column header text of the Delete Record Column Header.

DeleteRecordColumnWidth

The width of the Delete Record Colum.

DeleteRecordIconClass

The class of the Delete Record Icon.

DeleteRecordImageClass

The class of the Delete Record Image.

EditRecordButtonClass

The class of the Edit Record Button.

EditRecordButtonText

The text of the Edit Record Button.

EditRecordColumnHeaderText

The column header text of the Edit Record Column Header.

EditRecordColumnWidth

The width of the Edit Record Colum.

EditRecordIconClass

The CSS class of the Edit Record Icon.

EditRecordImageClass

The CSS class of the Edit Record Image.

ExcelExportAllPages

If set to true the grid will export all pages of data.

ExcelExportFileName

Specifies the file name of the exported Excel file.

ExcelExportFilterable

Enables or disables column filtering in the Excel file.

Filterable

If set to true the user can filter the data source using the grid filter menu.

GridHeight

The height of the grid. Numeric values are treated as pixels.

Groupable

If set to true the column will be groupable.

Pageable

If set to true the grid will display a pager.

PageableAllowRefresh

If set to true the pager will display the refresh button. Clicking the refresh button will refresh the grid.

PageableButtonCount

The maximum number of buttons displayed in the numeric pager. The pager will display ellipsis (...) if there are more pages than the specified number.

PageablePageSizes

The number of data items which will be displayed in the grid. Default values are 10,25,50,100, all.

PageSize

The number of data items per page. The property has no default value. That is why to use paging, make sure somepageSizevalue is set.

ReorderableColumns

If set to true the user could reorder the columns by dragging their header cells.

ResizableColumns

If set to true, users can resize columns by dragging the edges (resize handles) of their header cells.

Scrollable

If set to true the grid will display a scrollbar when the total row height (or width) exceeds the grid height (or width).

ServerFiltering

If set to true, the data source will leave the filtering implementation to the remote service.

ServerGrouping

If set to true, the data source will leave the grouping implementation to the remote service.

ServerPaging

If set to true, the data source will leave the data item paging implementation to the remote service.

ServerSorting

If set to true the data source will leave the grouping implementation to the remote service.

ShowColumnMenu

If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled).

Sortable

If set to true the user could sort the grid by clicking the column header cells.

VirtualScrolling

If set to true the grid will always display a single page of data. Scrolling would just change the data which is currently displayed.

GridEvents

GridEvents can be found under Advanced > Model > GridSettings > GridEvents

GridEvents Allows you to add events handlers to the Grid. This is a list of the different events available. You pass in a function name to handle the desired event. More documentation of the Kendo grid events can be found in here: https://docs.telerik.com/kendo-ui/api/javascript/ui/grid#events 

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

HidePrefix

The HidePrefix advanced property determines whether the prefix of a note should be hidden or not. By default this is set to false.

IncludePrefix

The IncludePrefix advanced property determines if the prefix of a note should be visible or not. By default this is set to false.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

IsHidden

Allows you to hide the widget when this property is set to true

API

readonly()

Sets the widget state to read only.

Returns

None

clear()

Clears the value of the widget.

Returns

None

disable()

Disables the widget on the page.

Returns

None

set_value()

Sets the text value of the widget.

Returns

None

get_kendoUpload()

Returns the Kendo Upload Object associated with the widget.

Returns

Kendo Object: kendo.ui.Upload

get_value()

Returns the value of the widget.

Returns

String

enable()

Enables the widget on the page.

Returns

None

get_type()

Returns the widget type.

Returns

String

get_kendoWindow()

Returns the Kendo Window Object associated with the widget.

Returns

Kendo Object: Kendo.ui.Window

get_windowPlaceHolder()

Returns the modal window associated with the widget.

Returns

jQuery Object

get_container()

Returns the container element of the widget.     

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_grid()

Returns the Kendo Grid Object associated with the widget.

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

Returns

Object     

get_popupTemplate()

Returns the script tag associated with the widget's popup template.

Returns

jQuery Object

hide()

Hides the widget from the form.

Returns

None

show()

Shows the widget on the form.

Returns

None

toggle()

Toggles the visibility of the widget.

Returns

None

Full API With Examples

Examples of SharePoint Document Grid Configuration