Configure a Sub Form

By Xelence Documentation posted 05-20-2022 14:52

Introduction

A sub form is like a record that displays next to the data table it's for. When the user selects a record from the data table, the application displays that record in the sub form section. The user can edit the record in the sub form. This allows the user to view, update, delete, and create records on a single screen, without having to navigate to a separate maintenance screen.

Prerequisites

The form you are going to use must already exist.

	Quick Steps
1	Search for and open the form
2	Add the Master Details control
3	Select the sub form template, then click Next
4	Enter the sub form details, then click Next
5	Select and configure the Master Details data table columns, then click Next
6	Select and configure the sub form fields, then click Finish
7	Update the section properties
8	Save the form

Detailed Steps

Step 1. Search for and open the form.

This is the form where you are going to create a sub form.

In this example, it is the Customer Lookup form.

Step 2. Add the Master Details control.

You cannot have multiple data table on a lookup form, so this example changes the existing Search Results section to a Master Details control.

Click the Change Control icon and select the Master Details control, then click OK.

Click Change Control and select Master Details

Step 3. Select the sub form template, then click Next.

A form template is a single file that contains multiple supporting files, such as files that define how controls on the form template should appear.

Step 4. Enter the sub form details, then click Next.

The properties are the Entity, which populates automatically; and the Type. Type options are List View, which allows the user to view the records in a list format; and Data Table, which allows the user to view the records in a data table format.

Step 5. Select and configure the Master Details data table columns, then click Next.

These are the columns you want in the Master Details data table. This example uses the columns that were already in the Search Results data table.

Optionally, use the arrow icons to change the order, or update the header text.

Besides the columns, this step allows you to select the data table buttons. These are the options you want the user to have to manipulate the data table.
There is also an 'Open On Row Select' checkbox. If checked, the application will open the sub form for any record the user clicks on.

Step 6. Select and configure the sub form fields, then click Finish.

These are the fields whose values you want to display in the sub form.

Optionally, use the arrow icons to change the order, or update the captions.

Besides the fields, this step allows you to select the sub form buttons (Save and Refresh).

Click the Finish button and Xelence will place the Master Details control.

Select the fields to be placed in sub form

Master Details Data Table and Sub Form added

Step 7. Update the section properties.

You can update the caption, column layout, and number of rows for the new Master Details section.

Step 8. Save the form.

Then, run the Preview. Xelence displays the form output. You can test your updated settings. When you have previewed your form, it should look something like this: