Checkbox Widget

  • Last update:March 26, 2025
  • Overview

    Version

    Report Server Version

    Functional Change

    11.0

    /

    11.0.30

    Allowed you to use formulas as label names. For details, see section "Parameter Widget."

    Application Scenario

    Data Entry Widget

    You can use the widget  to select multiple options in a data entry report, as shown in the following figure.

    2.gif

    Parameter Widget

    You can use the widget  to query data on the parameter panel, as shown in the following figure.

    1.gif

    Adding Method

    Data Entry Widget

    After selecting a cell, click Widget Setting on the right attribute panel and select Checkbox Widget from the drop-down list, as shown in the folloiwng figure.

    image 5.png

    Parameter Widget

    Drag the Checkbox Widget from the widget toolbar on the parameter panel into the parameter panel, as shown in the following figure.

    image 6.png

    Usage Description

    Differences between Checkbox Widget, Radio Button Group Widget, and Checkbox Group Widget:

    • Checkbox Widget has only one button for you to select (corresponding to the true value) and deselect (corresponding to the false value), which is suitable for yes-or-no scenarios.

    • Radio Button Group Widget has multiple buttons, each of which corresponds to a value. You can select one from the group of these buttons. This is suitable for multiple-choice scenarios.

    • Checkbox Group Widget has multiple buttons, each of which corresponds to a value. You can select multiple options from the group of these buttons. This is suitable for scenarios where you need to select more than one options.

    The following figure shows the three widgets.

    image 10.png

    Widget Introduction

    Attribute

    Data Entry Widget

    The following figure shows the Attribute tab page of  Checkbox Widget.

    image 11.png

    The following table describes each attribute setting item in detail.

    iconNote:
    The value of Checkbox Widget is true or false. During data entry, you can tick the checkbox (corresponding to true), untick the checkbox (corresponding to false), or perform no operation (in which case NULL is entered). The default value can be set by adding a value into the cell. If you do not set, the default value is NULL.

    Classification

    Setting Item

    Introduction

    Basic

    Widget Name

    Widget name (empty by default), which needs to be manually entered and is usually used together with a parameter. For example, the widget value can be passed to the corresponding parameter after the widget is obtained through the widget name.

    Available

    Whether the widget is available. When you tick Available, the widget can be edited during data entry. When you untick Available, the widget is grayed out and cannot be edited during data entry. Available is ticked by default.

    Visible

    Whether the widget is visible. When you tick Visible, the widget is displayed on the page during data entry. When you untick Visible, the widget is not displayed on the page during data entry. Visible is ticked by default.

    Advanced

    Text

    Label content (empty by default) attached to the widget, which will be displayed on the right of the button.

     

    Parameter Widget

    The following figure shows the Attribute tab page of Checkbox Widget.

    image 12.png

    The following table describes each attribute setting item in detail.

    Classification

    Setting Item

    Introduction

    Basic

    Widget Name

    Widget name (checkBox# by default), which needs to be manually entered and is usually used together with a parameter. For example, the widget value can be passed to the corresponding parameter after the widget is obtained through the widget name.

    Available

    Whether the widget is available. When you tick Available, the widget can be edited during data entry. Whenyou untick Available, the widget is grayed out and cannot be edited during data entry. Available is ticked by default.

    Visible

    Whether the widget is visible. When you tick Visible, the widget is displayed on the page during data entry. When you untick Visible, the widget is not displayed on the page during data entry. Visible is ticked by default.

    Advanced

    Label Name

    Label name used for   mobile terminals to recognize the widget. The widget label attribute is used   for mobile terminals. Mobile terminals do not support Label Widget on the parameter panel and can recognize the Label Name attribute of general   widgets.

    FineReport of V11.0.30 and later   versions allows you to use formulas as label names. You can enter a formula   text (starting with an equal sign) in the label name editing box. The formula   result will be automatically calculated and used as the final label name.

    iconNote:
    To dynamically display label names based on the language using the I18N() function, ensure that the Multi-language Plan Plugin is updated to V2.2.2. If the template-used keys (either used in the template or on the platform) are updated, you need to manually refresh the template for the new   keys to take effect.

    Text

    Label content (empty by default) attached to the widget, which will be displayed on the right of the button.

    Widget Value

    Default value used when the widget is initialized, which can be set to BooleanFormula, or Field. When you select nothing, the default value is false.

    Boolean: The value can be true or false. If you tick true here, the widget checkbox is selected by default during data entry. If you untick true (namely false) here the widget checkbox is deselected by default during data entry. The following figure shows an example when true is ticked.

    image 13.png

    Formula: You can enter true or false through a formula. For example, if the value of cell A1 is true and you enter A1 here, cell A1 is selected by default during data entry.

    image 14.png

    Field: You can specify a field from a dataset (includeing the template dataset and server dataset)   For example, after you bind the Whether Is Selected field (whose value is true in the dataset ds1) here, this field is selected by default during data entry.

    image 15.png

    For details, see Default Value for Checkbox Widget and Checkbox Group Widget.

    Font Size

    Font size (12 by default) of the label displayed on the right of the button.

    iconNote:
    The function is not supported on mobile terminals.

    Coords & Size

    Widget Location

    Location of the widget on the   parameter panel. The horizontal and vertical coordinates are  displayed automatically after the widget is   relocated on the parameter panel.

    Widget Size

    Widget size, which can be adjusted   by width and height. If you resize the widget by dragging, the height and   width will be automatically adjusted accordingly.

    Event

    The event setting page allows you to add events to the widget for certain effects. Checkbox Widget supports events such as After Initialization and State Change, as shown in the following figure.

    image 16.png

    Select an event type and add the event content. The event response methods supported by Checkbox Widget include JavaScript, Summit to Database, Send Email, Export Event, and Mobile Pop-up, as shown in the following figure.

    image 17.png

    You can select the corresponding event response method to add. For details, see Event Response Method.

    Mobile Terminal

    No option is configurable on mobile terminals.

    During the preview on mobile terminals, checkboxes in dashboards and parameter panels are changed to sliders, as shown in the following figure.

    image 18.png

    Application Example

    The following table introduces how to apply Checkbox Widget.

    Application Scenario

    Acutal Effect

    Scenario Description:

    On the parameter or data entry page, the checkbox in the added Checkbox Widget or Checkbox Group Widgetis deselected by default, but can be selected by default by setting. Alternatively, multiple checkboxes in Checkbox Group Widget can be selected by default.

    Help Document:

    Default Value for Checkbox Widget and Checkbox Group Widget

    1742906147634239.png

    Scenario Description:

    For reports with large amounts of data, Checkbox Widget can be used to customize a pop-up for query.

    Help Document:

    Custom Option Pop-up by JS

    1733495387423785.gif

    Scenario Description:

    When creating summary reports, you can use Checkbox Widget to dynamically sum only the values of the rows where checkboxes   are selected.

    Help Document:

    Sum of Values in Rows Where Checkboxes Are Selected

    1742868610693378.gif

     

    Attachment List


    Theme: Parameter
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    9s后關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy