FieldFormCheckBox class

FieldFormCheckBox class

Implements the FORMCHECKBOX field. To learn more, visit the Working with Fields documentation article.

Remarks

Inserts a check box style form field.

Inheritance: FieldFormCheckBoxField

Constructors

NameDescription
FieldFormCheckBox()The default constructor.

Properties

NameDescription
display_resultGets the text that represents the displayed field result.
(Inherited from Field)
endGets the node that represents the field end.
(Inherited from Field)
formatGets a FieldFormat object that provides typed access to field’s formatting.
(Inherited from Field)
is_dirtyGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
(Inherited from Field)
is_lockedGets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field)
locale_idGets or sets the LCID of the field.
(Inherited from Field)
resultGets or sets text that is between the field separator and field end.
(Inherited from Field)
separatorGets the node that represents the field separator. Can be None.
(Inherited from Field)
startGets the node that represents the start of the field.
(Inherited from Field)
typeGets the Microsoft Word field type.
(Inherited from Field)

Methods

NameDescription
get_field_code()Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
(Inherited from Field)
get_field_code(include_child_field_codes)Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field)
remove()Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns None.
(Inherited from Field)
unlink()Performs the field unlink.
(Inherited from Field)
update()Performs the field update. Throws if the field is being updated already.
(Inherited from Field)
update(ignore_merge_format)Performs a field update. Throws if the field is being updated already.
(Inherited from Field)

Examples

Shows how to process FORMCHECKBOX, FORMDROPDOWN and FORMTEXT fields.

# These fields are legacy equivalents of the FormField. We can read, but not create these fields using Aspose.Words.
# In Microsoft Word, we can insert these fields via the Legacy Tools menu in the Developer tab.
doc = aw.Document(file_name=MY_DIR + 'Form fields.docx')
field_form_check_box = doc.range.fields[1].as_field_form_check_box()
self.assertEqual(' FORMCHECKBOX \x01', field_form_check_box.get_field_code())
field_form_drop_down = doc.range.fields[2].as_field_form_drop_down()
self.assertEqual(' FORMDROPDOWN \x01', field_form_drop_down.get_field_code())
field_form_text = doc.range.fields[0].as_field_form_text()
self.assertEqual(' FORMTEXT \x01', field_form_text.get_field_code())

See Also