MMpy.FormSet.set_field

Syntax

formset.set_field(sequence_id, field_value, append_flag=MMpy.append_flag.none)

formset.set_field(sequence_id, form_set)

Description

Sets the value of a form set field.

Parameters

Name
Type
Description

sequence_id 

int or str ID or name of the field in the form set.

field_value 

any The value to set for the field.
append_flag MMpy.append_flag Behaviour of report file (if applicable). Defaults to MMpy.append_flag.none.
form_set MMpy.FormSet Embedded form set (if applicable).

See Also

MMpy.append_flag

Notes

field_value accepts any type of value provided it can be serialised to a string. This includes int, float, str and MMpy.FormSet (nested form sets).

Starting from v2020, more of the MMpy types are able to be directly assigned without calling object.serialise(), such as MMpy.Font, MMpy.Colour and more.

Valid choices for append_flag are:

  • MMpy.append_flag.report
  • MMpy.append_flag.output
  • MMpy.append_flag.none
  • MMpy.append_flag.plot

Examples

formset = MMpy.FormSet('WS_LOAD_GRIDFILE', '15.0.0.0')
...
formset.set_field('FILE', 'WOLF_TND.GRD')

Resource ID

IDPH_FORMSET_SET_FIELD