BeginNewFieldUpdateGroup
Description
Marks the beginning of a series of SetFieldValue calls.
You
can use this method to mark the beginning of a group of calls to SetFieldValue You can later call GetFieldsUpdatedThisGroup to
track which fields were updated. This technique is useful for web-based systems
where you might need to track any changes to the fields in a form. For example,
if the user moves to another web page, you can call the GetFieldsUpdatedThisGroup method to save the current state of the form and restore it when
the user returns to that page.
Syntax
VBScript
entity.BeginNewFieldUpdateGroup
Perl
$entity->BeginNewFieldUpdateGroup();
- Identifier
- Description
- entity
- An Entity object representing a user data record. Inside a hook, if you omit this part of the syntax, the Entity object corresponding to the current data record is assumed (VBScript only).
- Return value
- None.
Example
VBScript
BeginNewFieldUpdateGroup
SetFieldValue "field1", "1"
SetFieldValue "field2", "submitted"
SetFieldValue "field3", "done"
updatedFields = GetFieldsUpdatedThisGroup
' Iterate over all the fields that changed
For Each field In updatedFields
' ...
Next