Render PDF Forms on Android

The following section assumes you’re familiar with forms. If not, first see the introduction to forms guides for more details.

Form Support in PSPDFKit

PSPDFKit supports all form types listed in the PDF specification.

Type Field Object Annotation Object
Check, Radio, and Push Buttons ButtonFormField ButtonFormElement
List and Combo Boxes ChoiceFormField ChoiceFormElement
Text TextFormField TextFormElement
Signatures SignatureFormField SignatureFormElement

We differentiate between field objects and annotation objects; field objects have no visual representation of their own and are represented by FormField, while annotation objects are visual representations of a single control inside a form field and are represented by FormElement.

Disabling All Form Interactions

You can disable all form interactions and modifications using disableFormEditing:

val builder = PdfActivityConfiguration.Builder(context)
builder.disableFormEditing()
PdfActivityConfiguration.Builder builder = new PdfActivityConfiguration.Builder(context);
builder.disableFormEditing();

Licensing

PDF Forms is a separate component in your PSPDFKit license. Without this feature included in your license, your app won’t be able to view or interact with PDF forms. Please contact our sales team to add this feature to your license, or use a trial license if you want to try out this feature.

Signature form fields and signature form elements require that your license includes either Electronic Signatures or Digital Signatures, or that your license was originally obtained in April 2021 or earlier. If none of these requirements are met, then signature elements will be omitted, and other form elements will be shown.