You are here: User interface > User interface rules > Harness, Section, and Flow Action forms > Harness, Section, and Flow Action forms - Adding a Check Box

The Check Box control (PRPC Version 5)

The Checkbox control for check boxes is deprecated. Use the pxCheckbox control instead. See Adding check boxes.

If a section contains a deprecated check box or another control for which there is an improved alternative, a warning displays, along with an Update Controls button. Click Update Controls to automatically update deprecated controls in the section. Automatic update is not available for all controls; see Upgrading deprecated and outdated controls on the PDN.

This topic describes the PRPC Version 5 Check Box control, which uses the non-auto-generated control Checkbox to present a property as a TrueFalse value.

The Check Box control uses the auto-generated control pxCheckbox.

Cell Properties panel — Top Fields

Click the View propertiesicon to display the Cell Properties panel.

Your updates to this panel update the rule form upon clicking Apply.  If the panel is pinned(pin), the wireframe on the rule form changes immediately to reflect your inputs. If the panel is not pinned(pin), click Apply to apply your inputs.

Field

Description

Open icon

(Appears only when this field is in a section included within the current open rule.) Click to open the section that immediately contains the field.

Property

Select or type a property reference that identifies a single text value and has a Property Type of TrueFalse.

Alternatively, you can drag a property name from the lists of properties visible in the Application Explorer. Typically, this works for Single Value properties belonging to in the Applies to class of the current rule (or a higher class). If the container in which this field sits has a non-blank Using Page value, you can drag a Single Value property from within that embedded page property.

Click the Open icon to review the property (if the reference is to an existing property in the Applies To class of this rule or a parent of that class). If the property is not found, the New dialog box for the property form appears.

You can reference properties on any page identified on the Pages & Classes tab, using the normal notation pagename.propertyname for pages other than the page corresponding to the Applies To class of the rule.

If this field is in a cell of a section that includes parameter declarations on the Parameters tab, you can enter the notation param.NAME here, to use a parameter value for the field, where NAME identifies a string parameter. Make sure that the NAME parameter is declared on the Parameters tab, and that your application provides a non-blank value for the parameter value in all possible situations where the section appears. See Sections — Completing the Parameter tab.

For a harness, the property generally must be on the primary page of the rule — the page corresponding to the Applies To key part of the rule. However, a section within the harness may have a different Applies To class, and that section can include properties from its own class.

Control

To represent the property as a check box, keep the value Checkbox.

Click the View propertiesicon to supply parameter values for this Control rule. All parameters are optional.

Parameter

Description

ReadOnlySmartInfo Optional. Identify the Purpose key part of a section to present as a SmartInfo pop-up for this control when the field is read-only.
ReadWriteSmartInfo Optional. Identify Purpose key part of a section to present as a SmartInfo pop-up for this control when the field is read-only.
SmartInfoHeader Optional. Enter text to appear in a SmartInfo header.

Click OK to save parameter values.

If this check box is within a section that itself has parameters (defined on the Parameters tab of the Section form), you can reference a section parameter to supply a control parameter value, with the normal notation PARAM.Name.

Behavior

Optional. Leave blank if no dynamic form actions to other parts of the form are to occur based on user updates or values for this field.

To establish a dynamic form action, click the Gear icon to open the Client Event Editor in a new dialog window. Complete the Client Event Editor to select an event (OnBlur, OnChange, or OnClick) and the resulting form action.

Click the help icon on the Client Event Editor for assistance.For general information on this capability, see Harness and Section forms Help — Client Event Editor.

Client event support is not available for harnesses, sections, or flow actions that use directives.

Cell properties panel — General tab

The General tab for a check box is identical to the General tab for a Text Input control. See About the Text Input control — General tab.

Cell properties panel — Advanced tab

The Advanced tab for a check box is identical to the Advanced tab for a Text Input control. See About the Text Input control — Advanced tab.