Lists
This section covers list controls that are particularly useful when a large amount of information needs to be presented to the user in an easily consumable format.
Last updated
Was this helpful?
This section covers list controls that are particularly useful when a large amount of information needs to be presented to the user in an easily consumable format.
Last updated
Was this helpful?
List controls allows you to display repetitive content as a comprehensive ordered set of information. Each list control can be customized by selecting the control in the main designer canvas and clicking on the gear icon to access its properties.
The Canvas List control allows you to display your list as an editable canvas on your layout.
Data Source properties determines the origin of the list contents.
Defines what kind of data source is being used to help better configure the list. Based on the Type of Data Source, further configurations can be made available.
Dynamic The list content is not derived from predefined sources and is created when using the layout instead.
Selection The list content is derived from a Selection Query. Using this option requires you to set the Selection Data property to identify which query is being used to populate the list.
Class The list content consists of all objects of a specific class type. Using this options requires you to set the Class Data property to identify which class objects are being used to populate the list.
Determines which class field (if any) is used to define the field value and its position on the canvas.
Non-mandatory option to select a layout to open the items by double-click. Layouts of the class of the data source can be selected.
Sets the appearance of the item.
Specifies how the background color for the items is evaluated:
Default - Uses the default background color (defined by the system).
Fixed - Uses a defined background color (defined by the app creator in hex-colors).
Field - Uses a field for the source of the background color. Selected field represents the data source class that defines the background color for the items (in hex-colors).
Sets the background opacity by selecting a value from a value range 0% - 100% in increments of ten.
Specifies how the border color for the items is evaluated:
Default - Uses the default border color (defined by the system).
Fixed - Uses a defined border color (defined by the app creator in hex-colors).
Field - Uses a field for the source of the border color. Selected field represents the data source class that defines the background color for the items (in hex-colors).
Instance Context defines the context of an Instance Frame. It expands the scope of the control to include additional functions.
It is recommended to always have an Instance Frame within an Instance Context.
General properties of an instance context determines the behavior of the Instance Frame on your layout.
Determines that actions can be performed within the list control.
Determines that performing refreshes is allowed in the list control.
Determines that expressions can be used in the list control.
Determines that the sorting order of the list can be changed.
Determines that list items or results can be filtered.
Determines that sub-elements in the list can be expanded or collapsed.
The Instance Frame control allows object instances to be opened directly in the layout instead of a new page. It is normally used in sync with the List Context and List elements.
Sample use-case:
The Instance Frame can be used as an item viewer with a List on the left side of the layout and the frame in the center panel. This creates a typical user experience where when an item is selected from the list, the content is immediately loaded in the center viewer.
The List control is a basic control of the type that allows you to display a number of objects of the same type in order. The list content can be defined by retrieving all objects of a class or dynamically by using queries defined in the Query Designer.
If a list view mode has been saved for an user and that mode has been set as unavailable in the List control, the user's list view mode will be reset to the initial view mode.
Data Source properties determines the origin of the list contents.
Defines what kind of data source is being used to help better configure the list. Based on the Type of Data Source, further configurations can be made available.
Dynamic The list content is not derived from predefined sources and is created when using the layout instead.
Selection The list content is derived from a Selection Query. Using this option requires you to set the Selection Data property to identify which query is being used to populate the list.
Class The list content consists of all objects of a specific class type. Using this options requires you to set the Class Data property to identify which class objects are being used to populate the list.
Enabling this option allows you to configure the pagination behavior of the list.
Page Size Defines the number of items that should be loaded on each list page.
Disable Loading Further Pages Enabling this option removes the pagination behavior whereby only the first page with the number of items defined as Page Size are loading.
Choose here possible view modes of your list. This is especially useful as not all list support all view modes. Possible view modes are List, Timeline, Charting, Kanban, Grid and Gannt.
If a particular view mode is selected to be the initial view mode (as explained in the chapter below), when that view mode is deselected as possible view mode, then the initial view mode is change to the next possible view mode.
If you choose All when selecting view modes, any future view modes added will be automatically included. However, if you manually select all available view modes without using the All option, only currently available view modes will be selected and any future modes added will not be automatically included.
Specifies which mode is used by default when loading the list. Same options possible as for selection the possible view modes for you list (see above Possible View Modes)
User interaction properties help customize the user experience with regards to the list content.
Enabling this option changes the list behavior so that the list items are loaded as the user scrolls through the list.
Enabling this option allows the list to receive new updates dynamically without the need for a page refresh.
Enabling this option allows the list to be refreshed when an object is refreshed.
Enabling this option allows users to click on the list item, for instance to open an object item.
Enabling this option enables related classes (NM-Target) to be opened automatically.
Enabling this option allows linked classes to be displayed as part of the list content.
List actions properties allows you to customize how the user can interact with the list directly.
Enabling this option allows the user to change the display mode of the list.
Enabling this property provides the option to change the list sorting order to the user.
Enabling this property provides the option to refresh the list to the user.
Activation of this option provides the end user the possibility of executing number of in-built actions for each list item of the respective list. In addition, the instance workflows visible to the end user are shown and can be executed.
Enabling this option all information for all instances are loaded. Leads to performance losses.
Instance creation properties allows you to customize the options to create new list items.
Enabling this option prevents the user from creating items dynamically when using the list. Instead, the user should use a dedicated create option (if available) to generate new items.
Enabling this option prevents the user from creating multiple new items at once.
Enabling this property removes the dedicated create option in the list context menu.
Specifies which action should be executed when the user attempts to create a new list item.
Available only if the Data Source is set to Selection or Class. Open Item Execution properties determine how the list should behave when a user opens a list item.
This property set allows you to specify which layout should be used based on the link being opened.
List mode properties determines the design of the list when in List Mode.
Enabling this option allows multiple items to be edited simultaneously.
Only available if checkmark for 'Enable Bulk Editing' is set. Enabling this option will hide bulk editing default toolbar in the bulk editing mode.
Only available if a checkmark for 'Enable Bulk Editing' is set. When this option is enabled, then the list will always be displayed in a bulk edit mode. The mode cannot be started or ended through the left click-area, menu or toolbar action. A toolbar action 'Select all' selects and deselect all visible instances. The mode does not end when executing an action or workflow.
This option is only available if 'Enable Bulk Editing' is enabled and 'Bulk editing always on' is disabled. Enabling 'Left Click-Area to Start Bulk Editing' allows you to select multiple items for editing by clicking on the selector located on the left side of each list item.
Enabling this option determines whether the list should be organized in a hierarchical manner.
Charting mode properties determines the design of the list when in Charting Mode.
Enabling this option allows users to change the view when in Chart Mode.
Kanban mode properties determines the design of the list when in Kanban Mode.
Enabling this option allows the user to move the list items (represented as Kanban elements).
Grid mode properties determines the design of the list when in Grid Mode.
Activating this property provides the options for the user to change the filter settings of your grid.
Enabling this property allows list columns to be grouped as a single column in the grid.
Activating this property provides the create item option in the grid header on top of the grid.
Specifies the action to be executed when an item is selected from the grid.
Icon Determines which icon should be used to represent the instance action on the layout. Available only when an Instance Action is defined.
This option opens the grid column configuration wizard to help you determine your grid columns.
For columns which are special you can choose a background color in order to emphasize it.
Item appearance properties determine how the list items are displayed on your layout.
Defines the graphical layout of a list item.
Defines the graphical layout of the list header
Defines what should be displayed if the list contains no items.
Determines whether the design should be applied to alternating rows only.
Enabling this option removes the horizontal separator between list items.
Help properties allows you to customize the information displayed in the intro tour of your page. The intro tour typically goes through each item that contains help information.
Allows you to write Html code that is rendered as help text for your control.
Allows you to define where the help text tooltip should be displayed relative to your control.
Supported positions: Auto, Top, Left, Right, Bottom, Bottom-Left, Bottom-Middle, Bottom-Right
Allows you to define the order within the intro tour.
List Context defines the context of a list. It expands the scope of lists to include certain functions.
It is recommended to always have a List within a List Context.
General properties of a list context determines the behavior of the list on your layout.
Determines that actions can be performed within the list.
Determines that performing refreshes is allowed in the list.
Determines that expressions can be used in the list.
Determines that the sorting order of the list can be changed.
Determines that list items or results can be filtered.
Determines that sub-elements in the list can be expanded or collapsed.
