public class

CheckBoxFormElement

extends EditableButtonFormElement
java.lang.Object
   ↳ com.pspdfkit.forms.FormElement
     ↳ com.pspdfkit.forms.ButtonFormElement
       ↳ com.pspdfkit.forms.EditableButtonFormElement
         ↳ com.pspdfkit.forms.CheckBoxFormElement

Class Overview

A single checkbox form control which can be toggled to on or off.

Summary

Public Methods
String getExportValue()
Gets the export value set for this CheckBoxFormElement.
CheckBoxFormField getFormField()
Retrieve parent form field.
FormType getType()
Gets form type for CheckBoxFormElement.
[Expand]
Inherited Methods
From class com.pspdfkit.forms.EditableButtonFormElement
From class com.pspdfkit.forms.FormElement
From class java.lang.Object

Public Methods

public String getExportValue ()

Gets the export value set for this CheckBoxFormElement.

Returns
  • The export value or null if it isn't set.

public CheckBoxFormField getFormField ()

Retrieve parent form field.

Returns
  • Attached parent form field.

public FormType getType ()

Gets form type for CheckBoxFormElement. See FormType.

Returns
  • Form type for CheckBoxFormElement.