result property

FormField.result property

Gets or sets a string that represents the result of this form field.

@property
def result(self) -> str:
    ...

@result.setter
def result(self, value: str):
    ...

Remarks

For a text form field the result is the text that is in the field.

For a checkbox form field the result can be “1” or “0” to indicate checked or unchecked.

For a dropdown form field the result is the string selected in the dropdown.

Setting FormField.result for a text form field does not apply the text format specified in FormField.text_input_format. If you want to set a value and apply the format, use the FormField.set_text_input_value() method.

For a text form field the FormField.text_input_default value is applied if value isNone.

Examples

Shows how to insert a combo box.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

builder.write("Please select a fruit: ")

# Insert a combo box which will allow a user to choose an option from a collection of strings.
combo_box = builder.insert_combo_box("MyComboBox", ["Apple", "Banana", "Cherry"], 0)

self.assertEqual("MyComboBox", combo_box.name)
self.assertEqual(aw.fields.FieldType.FIELD_FORM_DROP_DOWN, combo_box.type)
self.assertEqual("Apple", combo_box.result)

# The form field will appear in the form of a "select" html tag.
doc.save(ARTIFACTS_DIR + "FormFields.create.html")

result property

FormField.result property

Remarks

Examples

See Also