Checkbox Group Manager
Previous  Top  Next

The Checkbox Group Manager is used to create a set of topic level checkboxes which will typically be used for every topic. For example, in the Texas 7A-0 report, each topic has four checkboxes for "Inspected", "Not Inspected", "Not Present" and "In Need Of Repair". By configuring a topic to use this group of checkboxes, you don't have to create individual comment templates that have the same set along with its topic caption for every topic. You can create the actual checkboxes in a single topic layout, and then use the Report View Manager to use a particular Checkbox Group for each topic that needs those checkboxes. Then, when entering your comments for a particular topic, you will have the topic level checkboxes in a blue shaded panel above the comment to check mark the applicable items:


Basically, the Checkbox Group Manager establishes a correlation between a topic's checkbox set and any topic checkboxes that were added in the layout. For example, if you had the following group set up in the Checkbox Group Manager:



And you had the following topic layout:


Then at report generation time, any topic that used the above layout and checkbox group, would have those checkboxes that appear in the layout checked from left to right and top to bottom, using the order as shown in the Checkbox group (and checked as they were in the editor):



Notes:


If you have fewer checkboxes in the layout than you have in the Checkbox Group, the extra checkboxes in the group will be skipped during report creation. However, you can make use of this "feature" by including a special checkbox that is used in the Print dialog to suppress certain topics if a particular checkbox is checked. For example, you could have an additional checkbox in the Checkbox Group, and call it something like "suppress". It will show up and be made available in the blue shaded panel above each topic comment editor, but will not be printed in the report since it is not represented in the topic layout. You can then use it in the Print dialog to suppress any topics that have the "suppress" checkbox checked.




If you have more checkboxes in the layout than you have in the Checkbox Group, those checkboxes will not be processed and will remain as set in the layout.


Checkbox Group Rules

As a convenience, you can optionally cause various checkboxes in the group to behave a certain way when you check or uncheck another checkbox by adding rules. For example, if you have both "Inspected" and "Not Inspected" checkboxes, you most likely will not want to allow both to be checked at the same time; therefore, you can add rules to prevent this from occurring.

Events (occur when the user clicks on one of the checkboxes):
OnCheck   Specifies what to do when a user checks the named checkbox.
   
Example: OnCheck(Inspected)
OnUncheck   Specifies what to do when a user unchecks the named checkbox
   
Example: OnUncheck(Inspected)

Actions (taken when a particular event occurs):
Check   Checks the specified named checkbox(es)
   
Example: Check(Inspected)
UnCheck   Unchecks the specified named checkbox(es)
   
Example: UnCheck(Not Inspected, Not Present)
Enable   Enables the specified named checkbox(es)
   
Example: Enable(In Need Of Repair)
Disable   Disables the specified named checkbox(es)
   
Example: Disable(Not Present, In Need Of Repair)

So, to prevent both the Inspected and Not Inspected checkboxes from both being checked or not checked at the same time, you can add these rules:

OnCheck(Inspected):UnCheck(Not Inspected)
OnCheck(Not Inspected):UnCheck(Inspected)
OnUncheck(Inspected):Check(Not Inspected)
OnUncheck(Not Inspected):Check(Inspected)


Notes:

The rules are not recursive, meaning that, in the above example, the unchecking action of the "Not Inspected" checkbox in the first rule does not trigger the last rule's event, OnUncheck(Not Inspected).

Only one event can occur per checkbox click, so only the first "OnCheck" event that matches the actual event will be processed (i.e. don't bother to have two "OnCheck(Inspected)" events because the second one would never get processed).

The name specified inside the parentheses must match the actual name of the checkbox given in the Checkboxes list; therefore, if you rename one of the checkboxes you must remember to change the name in the rules as well. The name is not case sensitive.

You can add additional actions to a single event by either adding other checkbox names in the action's parameter list, separated by commas, or joining different actions using the "and" clause. For example, if you also wanted to uncheck and disable say, the "In Need Of Repair" checkbox when you check the "Not Inspected" checkbox, you can create the rule:

OnCheck(Not Inspected):Uncheck(Inspected, In Need of Repair) and Disable(In Need Of Repair)