removeInstance

Removes a specified subform or subform set from the form model.

When removing a subform instance, avoid subform occurrence violations. You cannot remove a subform instance if it has reached the minimum number of instances. When a subform reaches the minimum number of instances, the JavaScript debugger displays an error message:

The element [min] has violated its allowable number of occurrences.

If the end user is allowed to remove every instance of a subform, reset the minimum number of instances to 0 before attempting to remove an instance. Otherwise, the script should prevent any attempt to remove subform instances beyond the minimum number.

Syntax

Reference_Syntax.removeInstance( INTEGER param )

Parameters

param

A valid integer representing the 0 based index position within the form model of the subform or subform set to remove.

Returns

Empty

Applies to

Version

XFA 2.1

Examples

JavaScript

Subform2.instanceManager.removeInstance(3);

FormCalc

Subform2.instanceManager.removeInstance(3)

// Ethnio survey code removed