If you would like to upgrade to a newer long-term support version of Studio Pro, see Moving from Mendix Studio Pro 8 to 9.

List View

Last modified: August 20, 2024

Introduction

A list view shows a list of objects. For example, you can display a list of all profiles:

Each object is shown using a template. This template is defined by placing widgets inside the list view’s drop-zone. The list of objects shown is determined by a data source.

Properties

An example of list view properties is represented in the image below:

List view properties consist of the following sections:

Common
Data source
Design Properties
General
Templates
Visibility

Common Section

For more information on properties in this section, see the Common Section section in Properties Common in the Page Editor.

Data Source Section

The data source determines which objects will be shown in a list view. For general information on data sources, see Data Sources.

Type

The list view supports the following types of data sources:

Database source – objects are retrieved directly form the database. The database source can be used in offline applications.
XPath source – objects are retrieved directly form the database
Microflow source – calculates the list of objects by executing a microflow
Nanoflow source – calculates the list of objects by executing a nanoflow
Association source – follows an association to get to objects

The database and XPath sources retrieve objects from the database and supports searching and sorting.

Searching is not supported on native mobile pages.

Design Properties Section

The Design Properties allow you to change spacing and alignment of the widget and hide it on phone, tablet, or desktop, if needed. Design properties may vary depending on the type of the widget. For example, for the text widget you can change its font weight, color, alignment, and letter case.

General Section

Editable

If this property is set to Yes, items in the list view can be edited. The changes made to list view items can be saved with a Save button and reverted with a Cancel button. On click and Page size properties are not displayed to avoid confusion about what changes are saved or reverted.

On Click

An on-click event defines what action is performed when a user clicks a list view row. For more information on on-click events, see On Click Event.

Page Size

the number of rows displayed on the page; after the indicated limit is reached, the Load more… button is displayed on the page.

The Load more button is not visible on native mobile pages. The list view will automatically load new items, when the last of the currently loaded items is shown.

Scroll Direction

The scroll direction property is only supported on native mobile pages.

This property determines whether the list view lays out its items vertically (default) or horizontally.

Number of Columns

The number of columns property is only supported on native mobile pages.

With this property you can change the number of items that will be shown next to each other in one row. If you set the scroll direction property to horizontal, this property determines the number of items per column.

Pull Down Action

The number of columns property is only supported on native mobile pages.

The pull down action defines what action is performed when you drag downwards on a list view. Its common behavior is to update the contents of the list view by synchronizing data.

Templates Section

Templates are not supported on native mobile pages.

If the entity that is connected to the list view has specializations, you can optionally specify templates for each specialization. For each row in the list view the most specific template is shown. The different templates can be selected by clicking the extra header that appears when a specialization template is added.

Let us say you have an entity Vehicle and two specializations thereof: Bicycle and Car. And there is a specialization of Car called SportsCar. You create a list view that is connected to Vehicle. With the templates property of the list view you specify what template to show for arbitrary Vehicles. For the specializations Bicycle and Car you create separate templates to show them.

Now if there is a row of type Bicycle the template specific for bicycles will be shown. A row of type Car will be shown in the template for Car. A row of type SportsCar is shown in the template for Car. There is no template specific for sports cars (in this example) and Car is the ‘closest’ generalization for which there is a template.

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 list view, 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
Go to data source nanoflow – this action is only displayed when a nanoflow is set as the data source and opens this nanoflow