Language Reference Guide : Events : ChildUnSelect Event
 
Share this page          
ChildUnSelect Event
The ChildUnSelect event is triggered for a composite field when the user unselects one of its child fields that is set to one of the select biases.
This event has the following syntax:
on childunselect [compositefieldname]
compositefieldname is optional if you specify the event in a field script for a composite field, or if the composite field is the frame's top form.
The following attributes of the FrameExec class can be used in the ChildUnSelect event block:
TriggerField
Specifies the select bias field that the user unselected
OriginatorField
Specifies the composite field specified in the initial on childunselect statement
SelectedList
Specifies the list of fields in the frame that remain selected
Use the CurFrame system variable to access these attributes. For more information, see FrameExec Class.
Usage: The ChildUnSelect event is defined for all composite fields, including the subform that is the frame's top form.
If you specify this event in the frame script without a composite field name, the ChildUnSelect event is triggered when an UnSelect event occurs on any field in the frame that is set to a select bias.
You can use the ChildUnSelect event when a child field has been unselected to track detailed select and UnSelect events separately. A field is unselected when the user selects another field, performs a Shift-select operation on a selected field, or clicks the form background (unselecting all selected fields). This event is used in visual editor applications that provide some type of a composite field canvas (usually a subform) on which the user can manipulate shapes or fields.
For example, if the user clicks the background to unselect all selected fields, a ChildUnSelect event is triggered for each field that was unselected. (To trigger a single event, rather than multiple ChildUnSelect events, each time a group of fields is unselected, use the SelectionChanged event defined for the frame.)
You can specify an UnSelect event block for a field and a ChildUnSelect event block for one or more of the enclosing composite fields for the field. OpenROAD executes the event blocks as described in Event Block Execution.
More information:
OriginatorField Attribute
SelectedList Attribute
TriggerField Attribute