Some test text!

Hamburger Icon

Python / Guides / Create form fields

Create new form fields and widget annotations in Python

To create new form fields and widget annotations within a new document.

# Create a blank page
doc = PDFDoc()
blank_page = doc.PageCreate()

# Create a new text field and text widget/annotation (aka AcroForms).
text_field = doc.FieldCreate("", Field.e_text, "")
text = TextWidget.Create(doc, Rect(110, 620, 380, 650), text_field)
text.SetFont(Font.Create(doc.GetSDFDoc(), Font.e_times_bold))

# Create a new signature field and signature annotation (aka AcroForms)
sig_field = doc.CreateDigitalSignatureField("employee.signature")
signature = SignatureWidget.Create(doc, Rect(0, 100, 200, 150), sig_field)

# Create a new checkbox field and checkbox widget/annotation (aka AcroForms)
checkbox = CheckBoxWidget.Create(doc, Rect(190, 490, 250, 540), "employee.checkbox")
checkbox.SetBackgroundColor(ColorPt(1, 1, 1), 3)
checkbox.SetBorderColor(ColorPt(0, 0, 0), 3)
checkbox.SetChecked(True) # Check the widget (by default it is unchecked).

# Create a radio button group and add three radio button widget/annotation (aka AcroForms) in it.
radio_group = RadioButtonGroup.Create(doc, "employee.radiogroup")
radiobutton1 = radio_group.Add(Rect(140, 410, 190, 460))
radiobutton1.SetBackgroundColor(ColorPt(1, 1, 0), 3)
radiobutton2 = radio_group.Add(Rect(310, 410, 360, 460))
radiobutton2.SetBackgroundColor(ColorPt(0, 1, 0), 3)
radiobutton3 = radio_group.Add(Rect(480, 410, 530, 460))
radiobutton3.EnableButton() # Enable the third radio button. By default the first one is selected
radiobutton3.SetBackgroundColor(ColorPt(0, 1, 1), 3)

# Add the page as the last page in the document.

PDF interactive forms (AcroForms)
Full code sample which illustrates some basic PDFNet capabilities related to interactive forms (also known as AcroForms).

About creating form fields

Regardless of which field type you create, you must provide a Field name:

my_field = doc.FieldCreate("address", Field.e_text)

Under most circumstances, field names must be unique. If you have a field you name as "address" and you create a second field you likewise call "address", you cannot supply different data in the two fields.

Field names can use alphanumeric characters to identify a field. All field names are case-sensitive. For example, you can use names such as empFirstName, empSecondName, empNumber, and so on for a group of fileds that are related to the same concept (in our sample employee entity).

Another technique for naming fields is to use a parent and child name. For example, you could name the above fields as follows:,, employee.number.

This naming convention is not only useful for organizing purposes but is well-suited for automatic operations on Fields. In the Apryse SDK, Field.GetName() returns a string representing the fully qualified name of the field (e.g. ""). To get the child name ("first") use the Field.GetPartialName() method.

For more information about adding Fields, see the FDF code sample .

Understand field types

PDF offers six different field types. Each type of form field is used for a different purpose, and they have different properties, appearances, options, and actions that can be associated with the fields. In this section, we will explain how to create all the seven field types and some attributes specific to each one.

Common field types are text-box, checkbox, radio-button, combo-box, and push-button. To find out the type of the Field use Field.GetType() method:

type = field.GetType()
if type == Field.e_button:
elif type == Field.e_check:
elif type == Field.e_radio:
    print(" Radio")
elif type == Field.e_text:
elif type == Field.e_choice:
elif type == Field.e_signature:

Get the answers you need: Chat with us