Loading...

List View

Properties API Related

Widget Type:
Page Widgets
TPC Version:
  • 4.1 +
List-view

List View allows you to retrieve your CRM data and display it on a page using your own custom HTML template. To configure this widget, you need to have a basic understanding of HTML markups. First drag and drop the list view widget in to your page body and click on the edit, it will open the widget designer.

Configuration

Basic

In the basic tab, you can enable or disable adding, editing and deleting records from the CRM. If you want to add or edit CRM data, you need to select a page with a form configured to the same entity as the List view entity. 

listview-1

Data

From the data tab, you can select the entity and attributes that you want to show on you list view. You have the option of working with the primary entity or any other entity that the one has a relationship with.

Load Default: Will load the default FetchXML that set to the selected CRM entity.

Build: Will let you build the FetchXML, and you will be able to select what fields that you want to display, filter the data, group the data.  

listview-2

Settings

In the settings tab, you can enable or disable paging and scrolling. 

listview-3

Filters

The Filters tab contains a myriad of options to filter the records that the widget fetches. For example, you can filter records by the logged-in contacts' ID or by a query string value.

Data Fields

The Columns tab allows you to define what data fields will appear in the TPC List view widget. It works alongside Fetch XML to define new columns for your widget. It will also give the option to edit the data column, set column header, change the HTML etc.

listview-4

Widget Properties

Basic Properties

CacheData

This property enables/disables CRM data caching. Defaults to false.

AddMissingLinkedEntityIds

Set to true out of the box, this attribute allows you to use the attributes of the link entities in the fetch on your templates, if this is set to false than the Unique Identifier for the Linked Entity will not be automatically added which means you wont be able to use the attributes of the linked entity in your template.

However if you want to return distinct values with your fetchXML, the value of this attribute needs to be false.

Allow Adding Records

The Allow Adding Records checkbox allows users to add records to the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the widget will use to add records.

Allow Editing Records

The Allow Editing Records checkbox allows users to edit existing records from the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the record will be edited from.

Allow Deleting Records

The Allow Deleting Records checkbox allows users to delete existing records from the CRM Entity that the widget is configured to use.

Enable Paging

The Enable Paging checkbox will organize fetched records into pages if they are over the paging size value. This can be changed from the widget itself.

Entity

Drop Down: Optional, select entity to use the Load Default FetchXML. Required in Advanced Pin Map: Used to dynamically populate image selectors list to differentiate markers by status.

Fetch XML

The FetchXML text area determines what sort of data a widget will be populated with. 

Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function.

EncryptGuids

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

EnableKendoThemes

The EnableKendoThemes property gives the user the ability to enable or disable Kendo themes provided by Kendo. Kendo themes are applied to all the TPC widgets that uses Kendo UI Widgets.

More Information about kendo Themes can be found in : http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling.

EnableBootstrapStyles

The EnableBootstrapStyles property gives the user the ability to enable or disable the Boostrap style  that added in to the current form. By default, this property is set to True. 

KendoTheme

The Kendo Theme property enables you to set a kendo theme to the form. Here are the list of kendo Themes that you set for this property;

  • Black
  • BlueOpal
  • Bootstrap
  • Default
  • Fiori
  • Flat
  • HighContrast
  • Material
  • MaterialBlack
  • Metro
  • MetroBlack
  • Moonlight
  • Nova
  • Office365
  • Silver
  • Uniform

More Information about kendo Themes can be found in 

http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling

PageablePageSizes

The PageablePageSizes advanced property determines which page size options are available to the user. Each page size is separated by a comma. By default this is set to '10,25,50,100,all'.

PageableButtonCount

The PageableButtonCount advanced property determines how many page size options are available to the user. By default this is set to '5'.

PageSize

You can set the how many records to show in the page by updating this property.

EnableKendoRtlSupport

The EnableKendoRtlSupport property gives the user the ability to enable or disable the Right to Left Support on the current form. By default, this property is set to False.

More Information about Kendo right to left support can be found in

 http://docs.telerik.com/kendo-ui/accessibility/supporting-rtl-languages

ListViewSettings

AddRecordButtonText

The text of the Add Record Button.

Filterable

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

Pageable

If set totruethe grid will display a pager.

PageableAllowRefresh

If set totruethe pager will display the refresh button. Clicking the refresh button will refresh the list view.

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.

Selectable

If set to true the rows are selectable.

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.

CacheData

This property enables/disables CRM data caching. Defaults to false.

AddMissingLinkedEntityIds

Set to true out of the box, this attribute allows you to use the attributes of the link entities in the fetch on your templates, if this is set to false than the Unique Identifier for the Linked Entity will not be automatically added which means you wont be able to use the attributes of the linked entity in your template.

However if you want to return distinct values with your fetchXML, the value of this attribute needs to be false.

Allow Adding Records

The Allow Adding Records checkbox allows users to add records to the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the widget will use to add records.

Allow Editing Records

The Allow Editing Records checkbox allows users to edit existing records from the CRM Entity that the widget is configured to use. When checked, you will be prompted to choose a page or a form from which the record will be edited from.

Allow Deleting Records

The Allow Deleting Records checkbox allows users to delete existing records from the CRM Entity that the widget is configured to use.

Enable Paging

The Enable Paging checkbox will organize fetched records into pages if they are over the paging size value. This can be changed from the widget itself.

Entity

Drop Down: Optional, select entity to use the Load Default FetchXML. Required in Advanced Pin Map: Used to dynamically populate image selectors list to differentiate markers by status.

Fetch XML

The FetchXML text area determines what sort of data a widget will be populated with. 

Clicking the Load Default Fetch option will populate the FetchXML area with a default fetch based on the CRM Entity chosen. By clicking the Build button, we will be sent to another page in order to determine what the widget will look up. For more information on how to use the FetchXML function.

EncryptGuids

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

EnableKendoThemes

The EnableKendoThemes property gives the user the ability to enable or disable Kendo themes provided by Kendo. Kendo themes are applied to all the TPC widgets that uses Kendo UI Widgets.

More Information about kendo Themes can be found in : http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling.

EnableBootstrapStyles

The EnableBootstrapStyles property gives the user the ability to enable or disable the Boostrap style  that added in to the current form. By default, this property is set to True. 

KendoTheme

The Kendo Theme property enables you to set a kendo theme to the form. Here are the list of kendo Themes that you set for this property;

  • Black
  • BlueOpal
  • Bootstrap
  • Default
  • Fiori
  • Flat
  • HighContrast
  • Material
  • MaterialBlack
  • Metro
  • MetroBlack
  • Moonlight
  • Nova
  • Office365
  • Silver
  • Uniform

More Information about kendo Themes can be found in 

http://docs.telerik.com/kendo-ui/styles-and-layout/appearance-styling

PageablePageSizes

The PageablePageSizes advanced property determines which page size options are available to the user. Each page size is separated by a comma. By default this is set to '10,25,50,100,all'.

PageableButtonCount

The PageableButtonCount advanced property determines how many page size options are available to the user. By default this is set to '5'.

PageSize

You can set the how many records to show in the page by updating this property.

EnableKendoRtlSupport

The EnableKendoRtlSupport property gives the user the ability to enable or disable the Right to Left Support on the current form. By default, this property is set to False.

More Information about Kendo right to left support can be found in

 http://docs.telerik.com/kendo-ui/accessibility/supporting-rtl-languages

ListViewSettings

AddRecordButtonText

The text of the Add Record Button.

Filterable

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

Pageable

If set totruethe grid will display a pager.

PageableAllowRefresh

If set totruethe pager will display the refresh button. Clicking the refresh button will refresh the list view.

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.

Selectable

If set to true the rows are selectable.

API

get_noDataTemplate()

Returns the no data template associated with the widget.

Returns

jQuery Object

get_type()

Returns the widget type.

Returns

String

noDataPlaceholder()

Returns the no data place holder associated with the widget.

Returns

jQuery Object

get_windowPlaceHolder()

Returns the modal window associated with the widget.

Returns

jQuery Object

get_pager()

Returns the Kendo Pager Object associated with the widget.

Returns

Kendo Object: kendo.ui.Pager

get_container()

Returns the container element of the widget.     

Returns

jQuery Object     

get_element()

Returns the element of the widget.

Returns

jQuery Object

hide()

Hides the widget from the page.

Returns

None

show()

Shows the widget on the page.

Returns

None

toggle()

Toggles the visibility of the widget.

Returns

None

get_listView()

Returns the Kendo ListView Object.     

Returns

Kendo Object: kendo.ui.ListView

get_kendoWindow()

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

Returns

Kendo Object: kendo.ui.Window

get_model()

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

Returns

Object

Full API With Examples

Examples of List View Configuration