pdftools_toolbox.pdf.forms.widget

Classes

Widget(handle)

A form field widget

class pdftools_toolbox.pdf.forms.widget.Widget(handle)[source]

Bases: _NativeObject

A form field widget

property bounding_box: Rectangle

The location on the page

Returns:

pdftools_toolbox.geometry.real.rectangle.Rectangle

Raises:

StateError – if the object has already been closed
pdftools_toolbox.corrupt_error.CorruptError – if the PDF is corrupt

property hidden: bool

The widget’s visibility

If True then the widget is present, but is invisible and not available for user interaction. Depending on the pdftools_toolbox.pdf.forms.widget.Widget.no_print property it will, however, still be visible when printing.

Returns:: bool
Raises:: StateError – if the object has already been closed

property locked: bool

Whether the widget can be modified

This does not restrict modification of the widget’s content.

Returns:: bool
Raises:: StateError – if the object has already been closed

property no_print: bool

The widget’s visibility when printing

If True then the widget is not present in a print output of the document.

Returns:: bool
Raises:: StateError – if the object has already been closed