Template Grid
Introduction
A template grid shows a list of objects in a tile view. For example, a template grid can show a list of employees with their profile pictures. Using controls provided by the template grid you can browse, search, and manipulate those objects:
The template grid has a lot in common with a data grid. The main difference is that the objects are shown in templates instead of rows.
Components
Control Bar
For more information, see Control Bar.
Search Bar
Search Bar is only available for Database and, below version 10.5, XPath data sources. For more information on a search bar and its settings, see Search Bar.
Properties
An example of template grid properties is represented in the image below:
Template grid properties consist of the following sections:
Common Section
The rows of the template grid can be sorted using the Sort order property. It is only available for Database data sources. For more information on sorting, see Sort Order.
Data Source Properties
The data source determines which objects will be shown in the template grid. For general information about data sources, see Data Sources.
Type
The template grid supports the following types of data sources:
- Database source – objects are retrieved directly form the database
- XPath source – objects are retrieved directly form the database
From Mendix version 10.5, the template grid widget does not have a separate XPath source, you can apply XPath constraints to the Database source.
- Microflow source – calculates the list of objects by executing a microflow
- Association source – follows an association to get to objects
The database and, below version 10.5, XPath sources retrieve objects from the database and supports searching and sorting.
Design Properties Section
General Section
Show Control Bar
This property indicates whether the control bar will be visible in the end-user interface. The control bar also includes the paging buttons.
Default: True
Show Paging Bar
With this property, you can change the way the paging bar is shown.
| Value | Description |
|---|---|
| Yes (with total count) | The paging bar is shown, including the Go to last page button and the total count of objects. |
| Yes (without total count) | The paging bar is shown (except for the Go to last page button). Also, the total count of objects is not shown, as page numbers are shown instead. |
| No | The paging buttons are not shown. |
Default: Yes (with total count)
Number of Rows
With this property you can change the number of rows of templates that will be shown on one page.
Default: 3
Number of Columns
With this property you can change the number of templates that will be shown next to each other in one row.
Default: 2
Style Template
The style template property allows you to choose from three different styling of the template grid. These stylings depend on your theme package.
Selection Mode
The selection mode determines whether and how the user can select items in the grid.
| Value | Description |
|---|---|
| No selection | The user cannot select items. |
| Single selection (default) | The user can select a single item by clicking on it. Clicking another item will make that item the selection. |
| Single selection and maintain | The user can select one item at a time by clicking on it. Users cannot deselect an item. By default the first item will be selected and removing a selected item will autoselect a subsequent item. |
| Multi-selection | The user can select multiple items by clicking the first one and holding the ‘Ctrl’ key while clicking on other items. Simply clicking an item will deselect all items and make the clicked item the selection. |
| Simple multi-selection | The user can select multiple items by simply clicking on them. |
Select First
This property indicates whether the first item will be selected initially. This is especially useful if there is a data view listening to this grid.
Default: False
Default Button Trigger
The default button can be triggered by single- or double-clicking a row.
| Value | Description |
|---|---|
| Single click | A single click triggers the default button. This cannot be used in combination with allowing the user to select rows. |
| Double click (default) | A double-click triggers the default button. |
Refresh Time (in Seconds)
If the refresh time is non-zero, the template grid will refresh its contents every given number of seconds. For example, a task list could be refreshed every minute so that you know when new tasks arrive. By default the refresh time is zero and this means that the grid will not automatically refresh itself.
Default: 0
Visibility Section
Visibility determines whether a widget is displayed to the end-user as part of the page.
For more information on properties of this section, see the Visibility Section section in Properties Common in the Page Editor.
Performing Specific Actions
To perform actions on a template grid, select it on a page and right-click it. The list of possible actions opens. While some actions from this list, such as Select data source, Edit condition for visible, are a quick way to set the properties, the following actions are specific actions that you can perform:
- Go to entity – opens a domain model and highlights an entity that is used as the data source
- Go to data source microflow – this action is only displayed when a microflow is set as the data source and opens this microflow