[Deprecated] - clearChoice( )

Use this helper function to clear values in multiple choice type questions.

Note:

As this function is deprecated, we recommend you use clearValue( ) instead, which is used for the same purpose and also supports text and number questions. However, rules that call clearChoice() still work to clear values in multiple choice questions.

To properly clear a rule target, this function needs to be used as the rule's return statement. See examples below.

For more information about clearing data, see Understanding data clearing.

Syntax

clearChoice()

Parameters

None.

Return value

This function is used as the return value of a calculation rule. It returns an indicator to the rule process to start data clear in the back end.

Examples

Example 3-90 Given a drop-down (choice) control, clear the control

// Clear a dropdown control. Must be returned to clear the control.
return clearChoice();
// clears the target calculated control

Related Topics

Parent topic: Multiple choice question functions