Back Forward Harness, Section, and Flow Action forms
Adding a Check Box control

About Harness rules

  Show all 

A cell in a layout can present in an HTML checkbox a property as a TrueFalse type. Follow these instructions to present a Check Box control. GRP-23741 v6.2 pashm

For a harness rule, 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 rule may have a different Applies To class, and that section can include properties from its own class. SR-37

As of V6.2, the Calendar control uses the auto-generated control rule pxCheckbox. Its look and behavior are governed by the Control rule form Control tab. The Parameters tab is not available and the HTML cannot be edited. To modify the control's look or behavior, use the control's Parameters dialog within the context of the section, not the rule itself.

It is recommended that you use pxCheckbox in new development rather than the non-auto-generated Checkbox control rule (which is supported). See About the Check Box control V5.1x.

  1. Drag and drop the Check Box control

Click the down-arrow (Arrow) at the right end of the Basic control group (Basics) and select the Check Box control (Check box). Drag the control to the cell or header that is to contain the property value. When the pointer changes shape to indicate that a single cell is selected, release the mouse button to drop the control.

If the cell is not empty, the dropped control replaces the current contents of the cell. Click the magnifying glass icon (Magnifying glass)to display the Cell Properties panel.

  2. Complete the Cell Properties panel — Top Fields

Complete the top fields of the Cell Properties panel.

Your updates to this panel can update the rule form immediately or upon clicking Apply, depending on the Property Panel settings in your Edit preferences. See Setting your preferences. 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

Pencil

(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

SmartPromptSelect or type a property reference that identifies a single text value and has a Property Type of TrueFalse. (If you are only prototyping a form and the property you want to reference is not yet defined, use the template property .pyTemplateCheckBox)

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. B-16325 Rejected

Click the pencil icon (Pencil) to review the property rule (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 Section rules — Completing the Parameter tab. Proj-1424

Control

SmartPrompt Accept the default pxCheckbox control rule. When placed in a SmartLayout field, the adjoining Label cell is populated by the standard .pyTemplateCheckbox property with a label value of Check Box. When placed in a repeating grid, the value appears above the control in the header cell.

Click the pencil icon (Pencil) to review the control rule identified in this field.

Customizing the control

The control's default parameters are the ones you'll most likely use in your UI design. If you wish, you can customize the control within the context of the section that contains it. For example, you can:

  • Enter a caption
  • Enter a tooltip
  • Enter True and False labels

Your edits apply only to the control within the section that contains it and do not update the underlying rule. You an add multiple controls of the same type within a section, each with its own custom settings. See Control Form — Completing the Control tab for descriptions of the available parameters and how to define behaviors.

Do the following to customize an auto-generated control rule in a section:

  1. Open the section or harness that contains the rule.
  2. Select the cell containing the rule and open its Cell Properties panel.
  3. In the panel, select the magnifying glass icon () next to the Control field. This displays the control Parameters dialog, which contains most of the settings in the underlying rule's Control tab. You cannot edit the Control Modes and UI Element settings.
  4. Modify as necessary. To immediately render your changes, click OK in the dialog. If satisfactory, save the section. The sy
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. C-1990

To establish a dynamic form action, click the magnifying glass icon (Magnifying glass) 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. C-2526

Click the help icon ( Help) on the Client Event Editor for assistance. For general information on this capability, see Implementing dynamic form actions and the Client Event Editor.

Client event support is not available for harness, section, or flow action rules that use directives.

  3. Complete the Cell properties panel — General tab

Complete the General tab.

For descriptions of the fields and options in this tab, see Adding a Text Input control — Complete the Cell Properties Panel — General tab.

  4. Complete the Cell properties panel — Advanced tab

Complete the Advanced tab.

For descriptions of the fields and options in this tab, see Adding a Text Input control — Complete the Cell Properties Panel — Advanced tab.

  Copying, deleting, duplicating, or moving a Check Box

TipUse these Windows operations to speed development:

Up About Flow Action rules

Up About Harness rules

Up About Section rules