The Field Class
- class PyPDF2.generic.Field(data)[source]
Bases:
PyPDF2.generic.TreeObject
A class representing a field dictionary. This class is accessed through
getFields()
- property additionalActions
Read-only property accessing the additional actions dictionary. This dictionary defines the field’s behavior in response to trigger events. See Section 8.5.2 of the PDF 1.7 reference.
- property altName
Read-only property accessing the alternate name of this field.
- property defaultValue
Read-only property accessing the default value of this field.
- property fieldType
Read-only property accessing the type of this field.
- property flags
Read-only property accessing the field flags, specifying various characteristics of the field (see Table 8.70 of the PDF 1.7 reference).
- property kids
Read-only property accessing the kids of this field.
- property mappingName
Read-only property accessing the mapping name of this field. This name is used by PyPDF2 as a key in the dictionary returned by
getFields()
- property name
Read-only property accessing the name of this field.
- property parent
Read-only property accessing the parent of this field.
- property value
Read-only property accessing the value of this field. Format varies based on field type.