docx_form.content_controls package

Submodules

docx_form.content_controls.CheckBoxContentControl module

class docx_form.content_controls.CheckBoxContentControl.CheckBoxContentControl(root: _Element, file_path: str)

Bases: DocxContentControl

This class contains the properties and functions associated with the Check Box content control.

Parameters:

DocxContentControl – This class extends DocxContentControl

set_check_box(check_value: bool)

This method sets a checkbox to checked or unchecked on a CheckBox Content Control

Parameters:

check_value (bool) – Sets checkbox to checked for true and unchecked for false

docx_form.content_controls.ComboBoxContentControl module

class docx_form.content_controls.ComboBoxContentControl.ComboBoxContentControl(root: _Element, file_path: str)

Bases: OptionalContentControl

This class contains all properties and methods for a ComboBox content control.

Parameters:

OptionalContentControl – This class extends the OptionalContentControl class

docx_form.content_controls.DatePickerContentControl module

class docx_form.content_controls.DatePickerContentControl.DatePickerContentControl(root: _Element, file_path: str)

Bases: DocxContentControl

This class contains all properties and methods for a DatePicker content control.

Parameters:

DocxContentControl – This class extends the DocxContentControl class

set_date(new_date: datetime) → None

This method sets the date of a DatePicker content control using a datetime object. The format of the date is determined by the date_format property. Make sure to supply a valid format string that strftime can use.

Parameters:

new_date (datetime) – The new date to set.

Return None:

None

docx_form.content_controls.DocxContentControl module

class docx_form.content_controls.DocxContentControl.DocxContentControl(root: _Element, file_path: str)

Bases: object

This is the parent class of all supported content controls. It is responsible for getting the id and text of the content control.

docx_form.content_controls.DropDownListContentControl module

class docx_form.content_controls.DropDownListContentControl.DropDownListContentControl(root: _Element, file_path: str)

Bases: OptionalContentControl

This class contains all properties and methods for a Drop-Down List content control.

Parameters:

OptionalContentControl – This class extends the OptionalContentControl class

docx_form.content_controls.PlainTextContentControl module

class docx_form.content_controls.PlainTextContentControl.PlainTextContentControl(root: _Element, file_path: str)

Bases: TextualContentControl

This class contains all properties and methods for a Plain Text content control.

Parameters:

TextualContentControl – This class extends the TextualContentControl class

docx_form.content_controls.RichTextContentControl module

class docx_form.content_controls.RichTextContentControl.RichTextContentControl(root: _Element, file_path: str)

Bases: TextualContentControl

This class contains all properties and methods for a Rich Text content control.

Parameters:

TextualContentControl – This class extends the TextualContentControl class

Module contents