List Widget-FineReport Help Document

Last update：May 15, 2025

Overview

Version

Report Server Version	Functional Change
11.0	/

Application Scenario

List Widget does not support parameter application. List Widget allows only data display during data entry, but does not allow data linkage and submission, as shown in the following figure.

Adding Method

Select a cell, click Widget Setting on the right attribute panel, and select List Widget from the drop-down list of Select Widget, as shown in the following figure.

Note:

You cannot use list widgets on the parameter page.

Widget Introduction

Attribute

The following figure shows the Attribute setting page for List Widget.

The following table describes each attribute setting item in detail.

Category	Setting Item	Introduction
Basic	Widget Name	Widget Name allows you to set the widget name. The widget name, which needs to be entered manually, is usually used together with parameters. For example, you can pass the widget value to the corresponding parameter after obtaining a widget by the widget name. Widget Name is empty by default.
	Available	Available allows you to determine whether the widget is available for use. If you tick Available, the widget can be edited during data entry. If you deselect Available, the widget is grayed out and cannot be edited during data entry. Available is ticked by default.
	Visible	Visible allows you to determine whether the widget is visible. If you tick Visible, the widget is displayed on the page during data entry. If you deselect Visible, the widget is not displayed on the page during data entry. Visible is ticked by default.
Advanced	Data Dictionary	Data Dictionary allows you to bind the list options to the widget. This setting is mandatory. If you do not configure the setting, the widget will not be displayed. For details, see Data Dictionary.
	Remove Repeated Data	Remove Repeated Data allows you to determine whether to merge duplicate options. If you tick Remove Repeated Data, the duplicate options in the list will be merged. Otherwise, the duplicate options will be retained. Remove Repeated Data is ticked by default.
	Need List Header	Need List Header allows you to determine whether you can perform operations on the list data. If you tick Need List Header, you can add, delete, and modify the list data during Data Entry Preview. If you deselect Need List Header, you can select only the default list data during Data Entry Preview.
Validation	Allow Null	Allow Null allows you to determine whether the list can be null. If you tick Allow Null, the list can be null. If you deselect Allow Null, a prompt appears during data entry validation and submission.
Validation	Error Tip	Error Tip refers to the setting item appearing when Allow Null is deselected, allowing you to customize the prompt message. "not null" is displayed by default.

Event

On the Event setting page, you can add events to widgets to achieve certain effects. Two events, namely, After Initialization and Click, are available for List Widget, as shown in the following figure.

After selecting a type of event, you can add the event content. Five event response methods, namely, JavaScript, Submit to Database, Send Email, Export Event, and Mobile Pop-up, are supported by List Widget, as shown in the following figure.

You can select and add the corresponding event response method. For details about differences among different response methods, see Event Response Method.