docx_form package

Subpackages

• docx_form.constants package
  • Submodules
  • docx_form.constants.constants module
  • Module contents
• docx_form.content_controls package
  • Submodules
  • docx_form.content_controls.CheckBoxContentControl module
    • CheckBoxContentControl
      • CheckBoxContentControl.set_check_box()
  • docx_form.content_controls.ComboBoxContentControl module
    • ComboBoxContentControl
  • docx_form.content_controls.DatePickerContentControl module
    • DatePickerContentControl
      • DatePickerContentControl.set_date()
  • docx_form.content_controls.DocxContentControl module
    • DocxContentControl
  • docx_form.content_controls.DropDownListContentControl module
    • DropDownListContentControl
  • docx_form.content_controls.PlainTextContentControl module
    • PlainTextContentControl
  • docx_form.content_controls.RichTextContentControl module
    • RichTextContentControl
  • Module contents
• docx_form.enums package
  • Submodules
  • docx_form.enums.tag_types module
    • TagType
      • TagType.P
      • TagType.SDT
  • Module contents
• docx_form.type_aliases package
  • Submodules
  • docx_form.type_aliases.element module
  • Module contents

Submodules

docx_form.docx_form module

class docx_form.docx_form.DocxForm(file_path: str)

Bases: object

This is the one and only entry point for the DocxForm package. DocxForm holds all content controls for a given document and allows read and write operations on the document.

print_all_content_controls_and_form_fields()

This method prints all content controls and form fields in the document.

save(destination_path: Optional[str] = None)

This method saves the document to the destination path if a path is given. If not, the original file is overwritten. :param str destination_path: The full path to save the file to, defaults to None

Module contents