List View form control

A form control that lets a form user view the form-based app data in a table.

Figure: Desktop View

Desktop View
Figure: Mobile View

Mobile View

Configure the List View form control

To configure the List View List View icon control, do the procedure in this topic.

Video: Build a Custom Search Screen

Video: Common Configuration Settings in eForm Controls

Prerequisites

  • The List View form control is only available for View forms in form-based apps.

How to Start

  1. Open eForm Builder in a form-based app.

    For information about how to open this screen, refer to eForm Builder screen.


    Eform Builder screen
  2. On the eForm Builder screen, in the Toolbox, open the Advanced Controls tab.

    Advanced Controls tab
  3. On the Advanced Controls tab, drag a List View List View icon form control onto your eForm.

    List View control

Procedure

  1. Complete the settings on the configuration screens.

    You can use the Data screen screen to specify a variable.

General

Specifies the basic configuration for the List View form control.

Figure: General tab

General tab

Fields

Field NameDefinition

Label
Description:
Specifies the text label that shows on your form for the control.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Internal Name
Description:
Specifies a unique, technical name for your control.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
Different for different controls.
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Help Text
Description:
Specifies the text to shows when a runtime app user hovers their cursor over the form control.
Allowed Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Help Text Display
Description:
Specifies if the field shows the text in the Help Text field when the runtime app user hovers over the label or field.
Allowed Values:
  • None - Does not show the help text.
  • Hover On Label - Shows the help text when you put your mouse on the label.
  • Hover On Field - Shows the help text when you put your mouse on the field.
  • Hover On Both - Shows the help text when you put your mouse on the label and Field.
Default Value:
None
Example:
Refer to:

Configure

Configures advanced settings for your form control.

Figure: Configure tab

Configure tab

Fields

Field NameDefinition

Lookup Source
Description:
Specifies a reusable lookup configuration. The lookup configuration includes the data source and other configuration values for the lookup.
Allowed Values:
A valid lookup source
Default Value:
None
Example:
Refer to:

Add Lookup Add Lookup icon
Function:
Opens the screen to configure a lookup.

There is more than one path to configure a lookup. Make sure you use the document that shows the path for your lookup.

Auto Generate Lookup Columns
Description:
Specifies if the form control completes the header and columns using information from your data source.
Allowed Values:
  • Selected - Completes the header and columns of the grid using data from your data source.
  • Deselected - Does not complete the header and columns of the grid.
Default Value:
Deselected

Header
Description:
Specifies the heading for the column.
To Open this Field:
  1. On the Configure tab, in the List Type field, select Inline List.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
Column 1

Bound Column
Description:
Completes the column value using a specified field from your lookup source.
Allowed Values:
A column value from the list.
Default Value:
None

Width (px)
Description:
Specifies the width of the column in pixels for the list view.
To Open this Field:
  1. In the Lookup Source field, select your lookup from the list.
Allowed Values:
An integer.
Default Value:
None
Limitations:

This field is available in these releases:

Visible
Description:
Specifies if the runtime app user sees the field.
Allowed Values:
  • Selected - The runtime app user sees the field.
  • Deselected - The runtime app user does not see the field.
Default Value:
Selected
Example:
Refer to:

Visible in Mobile
Description:
Specifies if the form field shows on a mobile device.
Allowed Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Selected

Enable in Bulk Edit
Description:
Specifies whether the column is enabled for bulk edit in the list view.
To Open this Field:
  1. In the Lookup Source field, select your lookup from the list.
  2. Select the Allow Bulk Edit field.
Allowed Values:
  • Selected - A runtime app user can change the values for more than one row in the column at the same time.
  • Deselected - A runtime app user can change the values only one row at a time in the column.
Default Value:
Selected
Limitations:

Add Column

Function:
Adds more rows.

Allow Add
Description:
Specifies whether the form user can add new records.
Allowed Values:
  • Selected - Lets the form user add new records.
  • Deselected - Does not let the form user add new records.
Default Value:
Selected
Example:
Refer to:

Allow Delete
Description:
Specifies whether the form user can delete records.
Allowed Values:
  • Selected - Lets the form user delete records.
  • Deselected - Does not let the form user delete records.
Default Value:
Selected

Allow Edit
Description:
Specifies if the form user can change values in the data grid.
Allowed Values:
  • Selected - Lets the form user change the values.
  • Deselected - Does not let the form user change the values.
Default Value:
Selected

Allow Clone
Description:
Specifies whether to show the Clone option on the View form in a form-based app so the runtime app user can clone the records.
Allowed Values:
  • Selected - Shows the Clone option on the View form, and runtime app users can clone the records.

    When the runtime app user clicks the Clone option on the record, it opens the form with the data specified from the selected record so the runtime app user can submit the form to create a new record with no change to the data.

  • Deselected - Does not show the Clone option on the View form, and runtime app users can not clone the records.
Default Value:
Deselected
Limitations:

Allow Bulk Edit
Description:
Specifies whether the runtime app user can change the values for more than one row at the same time in the data grid.
To Open this Field:
  1. On the Configure tab, select the Allow Edit field.
Allowed Values:
  • Selected - Lets the runtime app user change the values for more than one row at the same time.
  • Deselected - The runtime app user can change the values on one row at a time.
Default Value:
Deselected
Limitations:

Allow runtime user to select Views
Description:
Specifies if the form user can select the view as a default view.
Allowed Values:
  • Selected - The form user can select the default view.
  • Deselected - The form user can not select the default view.
Default Value:
Selected

Appearance

Specifies the look and feel for your form control.

Figure: Appearance tab

Appearance tab

Fields

Field NameDefinition

Font Family
Description:
Specifies the font family of the input text and label.
Allowed Values:
A font name from the list.
Default Value:
  • Modern theme - Roboto
  • Classic theme - Arial
Example:
Refer to:

Font Size (px)
Description:
Specifies the size of the input text and label for your form control.
Allowed Values:
An integer.

Range:

  • Greater than 0
Default Value:
  • Classic theme - 12
  • Modern theme - 14
Example:
Refer to:

Font Style
Description:
Specifies the style of the font for the input text and label.
Allowed Values:
  • Bold - Shows the input text and label in bold.
  • Underline - Shows the label underlined.
  • Italic - Shows the label in italic.
Default Value:
None
Example:
Refer to:

Foreground Color
Description:
Specifies the foreground color for your control.
Allowed Values:
A color value using a hex code, RGB code, or RGBA code.

You can enter a color code, or select a color from the palette.

Default Value:
#ff0000
Example:
Refer to:

Show Grid Lines
Description:
Specifies whether the View form in a form-based app shows the data with grid lines.
Allowed Values:
  • Selected - Shows the form data with grid lines.
  • Deselected - Shows the form data with no grid lines.
Default Value:
Deselected
Limitations:

This field is available in these releases:

Label CSS Class
Description:
Specifies a CSS class for the label of your control.
Allowed Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Container CSS Class
Description:
Specifies a CSS class for the container of your control.
Allowed Values:
A valid CSS class.
Default Value:
None

If you specify your CSS CSS icon on the top menu, the CSS is populated.

Example:
Refer to:

Behavior

Specifies how the control shows on your form.

Figure: Behavior tab

Behavior tab

Fields

Field NameDefinition

Visible
Description:
Specifies if the runtime app user sees the field.
Allowed Values:
  • Selected - The runtime app user sees the field.
  • Deselected - The runtime app user does not see the field.
Default Value:
Selected
Example:
Refer to:

Label Position
Description:
Specifies the position of the text label that shows on your form for the control.
Allowed Values:
  • Inherit - The position of the label is as specified in the form settings.
  • Left - Specifies that the position of the label is to the left of the container.
  • Top - Specifies that the position of the label is to the top of the container.
Default Value:
Inherit
Example:
Refer to:

Advanced

Specifies advanced settings for your form control.

Figure: Advanced tab

Advanced tab

Fields

Field NameDefinition

Field ID
Description:
Shows an ID of the control.
Allowed Values:
Read only.
Default Value:
Different for different controls.
Example:
Refer to:

Maximum Height (px)
Description:
Specifies the maximum height for your control in pixels.
Allowed Values:
An integer.

Range:

  • 1-9999
Default Value:
300

Export as CSV
Description:
Specifies if an Export as CSV button shows on the form control This button exports the data grid to a file in .csv format.
Allowed Values:
  • Deselected - The Export as CSV button is not shown.
  • Selected - The Export as CSV button is shown.
Default Value:
Deselected

Enable Filtering
Function:
Specifies whether to show the filter icon at runtime where the form user can specify a condition to filter the column.
Allowed Values:
  • Selected - Shows the filter icon at runtime to where the form user can specify a condition for the column filter.
  • Deselected - The user can not filter the column.
Default Value:
Deselected
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Data Security Settings
Description:
Specifies whether to store information from the field in the process schema, so the app can use it again, or to simply pass on the information after the form is submitted without storing the information. This option helps to protect sensitive user information.
Allowed Values:
  • Persist - Stores the data from the field in the process schema, so the app can use it again.
  • Do Not Persist - Does not store the data from the field in the process schema. This option provides greater security for sensitive user information.
Default Value:
Persist
Example:
Refer to:

Page Size
Description:
Specifies size of the field on your form.
Allowed Values:
An integer.
Default Value:
10

Show On Tablet Devices
Description:
Specifies if the form field shows on a tablet.
Allowed Values:
  • Selected - The form field shows on a tablet.
  • Deselected - The form field does not show on a tablet.
Default Value:
Selected
Example:
Refer to:

Show On Mobile Phone Devices
Description:
Specifies if the form field shows on a mobile device.
Allowed Values:
  • Selected - The form field shows on a mobile device.
  • Deselected - The form field does not show on a mobile device.
Default Value:
Selected
Example:
Refer to: