pdftools_toolbox.pdf.forms.radio_button

Classes

RadioButton(handle)

A button in a radio button group

class pdftools_toolbox.pdf.forms.radio_button.RadioButton(handle)

Bases: _NativeObject

A button in a radio button group

add_new_widget(bounding_box: Rectangle) → Widget

Create radio button widget

This method creates a widget for the radio button. The widget is automatically added to the button’s widgets and to the radio button form field’s widgets, but not to any page.

Parameters:

boundingBox (pdftools_toolbox.geometry.real.rectangle.Rectangle) – The widget’s target rectangle on the page

Returns:

the newly created form field widget

Return type:

pdftools_toolbox.pdf.forms.widget.Widget

Raises:

• StateError – if the document has already been closed

• OperationError – if the document is read-only

property export_name: str | None

The button’s name used when exporting

Returns:

Optional[str]

Raises:

StateError – if the object has already been closed

property widgets: WidgetList

The button’s widget annotations

Returns:

pdftools_toolbox.pdf.forms.widget_list.WidgetList

Raises:

StateError – if the object has already been closed