The List Field presents the user with an unlimited number of rows that can be added to the Field in your application, unlike the Gridfield which is a defined, and therefore fixed set of rows. However, both still columns to be defined in AppStudio.
New List Field
To create a new List Field, you must first be in the 'Fields' section of AppStudio, here you will be able to click the 'Add Field' button in at least one of the highlighted locations below.
This will open the following page where you can scroll down and select the the List Field tile or search for it in the top right bar:
Once selected, you will need to begin by defining the following:
- Label: What name do you want to give the List Field, this will be displayed in your App.
- Identifier: What is the unique system identifier for this Template? This is auto-generated as the Label with no spaces, but can then be overwritten if required. This should reflect the Label you have given it, but cannot have spaces.
- Default Sort By: If desired you can choose a default column for the List Field to be alphabetically sorted by. For example this could be a 'Risk Type' column.
- Default Sort Order: Do you want the Default Sort By to be Ascending or Descending?
- Add Row Enabled: When enabled, allows the a User with greater than Read-Only Record Permission to add Rows (items to the List). When unticked this can be used in audit related apps when they need to answer a defined number of questions and not be able to add any more.
- Delete Row Enabled: This is the reverse 'Add Row Enabled', allowing the User to remove Rows.
- Exclude This Field From Templated Record Copies: If toggled, the data in this Field will be excluded from future copies of Records, whenever 'Template Copy' is selected for the copy.
The process of Configuring a List Field Column is almost identical to any other Field, except here they will comprise the Column titles of the List Field.
- Label: What label do you want to give the Column?
- Identifier: The unique system reference for the Field, it should reflect the Label but with no spaces.
- Type: Choose the column Field from almost all Field Types.
- Alignment: This will change the displayed orientation of the data in the Column: Left | Middle | Right
- Length: Gives the option to define the allowed number of characters.
- Format String: Allows for formatting of the Field.
- Default Value: Do you want the Field to have a given value whenever a new List item is added with the '+'. For example if the Field Type was a 'RAG' MultiState the default value could be 'Red'.
- Col Width (Optional): Use the denotation px (pixels) to set the width of the Column on the screen. This can give a more tailored User Experience. For reference, with 5 columns, ranging between 150px-500px is a good place to start.
- Display Formatted: This shows the version of the Field that has the Format String applied (only if defined).
- Required: Does this Field in the List have to have data in it before the Record can be created? If this is set and it's left blank a Validation Error will occur.
Tip: Column Widths are strict once set so their effectiveness is subject to the device they were set on. They tend to work best on desktop / laptop, if the App is likely to be used outside of these, then you should try and test on the other devices first.
Make sure to click the 'Save' button when making any changes in order for them to be added to the next app version. Once you have made all the changes you need to an application you are then ready to publish it to workspace.
Related List Field Expressions: Here