Forms | API Reference | PSPDFKit for macOS


                      
                      
                      
                      
                      PSPDFButtonFormElement

Button Form Element (check boxes, radio buttons, regular form push buttons)

Declaration

Objective-C


@interface PSPDFButtonFormElement : PSPDFFormElement <NSSecureCoding>

Swift

class ButtonFormElement : FormElement, NSSecureCoding


                      
                      
                      
                      
                      PSPDFButtonFormField

Represents one button form field in a PDF form. They come in three variants:

A push button that can have a action attached to it.
A check box that can be independently checked or unchecked.
A radio button that are mutually exclusive.

A PSPDFButtonFormField can be the parent of multiple buttons, like a RadioButton group.

Declaration

Objective-C


@interface PSPDFButtonFormField : PSPDFFormField

Swift

class ButtonFormField : PDFFormField


                      
                      
                      
                      
                      PSPDFChoiceFormElement

Choice Form Element.

Declaration

Objective-C


@interface PSPDFChoiceFormElement : PSPDFFormElement

Swift

class ChoiceFormElement : FormElement


                      
                      
                      
                      
                      PSPDFChoiceFormField

Represents a choice form field in a PDF form. This allows the user to select one of the given options or, if isEdit is true, enter their own option value.

Declaration

Objective-C


@interface PSPDFChoiceFormField : PSPDFFormField

Swift

class ChoiceFormField : PDFFormField


                      
                      
                      
                      
                      PSPDFFormElement

Represents a PDF form element.

Declaration

Objective-C


@interface PSPDFFormElement : PSPDFWidgetAnnotation <NSSecureCoding>

Swift

class FormElement : WidgetAnnotation, NSSecureCoding


                      
                      
                      
                      
                      PSPDFFormField

A form field represents one logical field in the PDF form. Use a PSPDFFormParser to retrieve them. You can access the form parser from a Document or PSPDFDocumentProvider.

Declaration

Objective-C


@interface PSPDFFormField : PSPDFModel <PSPDFUndoSupport, NSSecureCoding>

Swift

class PDFFormField : ModelObject, UndoSupport, NSSecureCoding


                      
                      
                      
                      
                      PSPDFFormOption

Undocumented

Declaration

Objective-C

@interface PSPDFFormOption : NSObject <NSSecureCoding>

PSPDF_EMPTY_INIT_UNAVAILABLE

/// Initializes an instance of this class with a label and value.
- (instancetype)initWithLabel:(NSString *)label value:(NSString *)value NS_DESIGNATED_INITIALIZER;

/// The label of the option which should be presented to the user.
@property (nonatomic, readonly) NSString *label;

/// The value that gets exported for the given option. Can be the same as `label`
@property (nonatomic, readonly) NSString *value;

@end

Swift

class PDFFormOption : NSObject, NSSecureCoding


                      
                      
                      
                      
                      PSPDFFormParser

Parses PDF Forms (“AcroForms”). This will not create objects based on the (soon deprecated) XFA standard.

See

https://pspdfkit.com/guides/ios/current/rendering-issues/pspdfkit-doesnt-show-the-pdf-form/

Declaration

Objective-C


@interface PSPDFFormParser : NSObject <PSPDFOverridable>

Swift

class PDFFormParser : NSObject, Overridable


                      
                      
                      
                      
                      PSPDFSignatureFormElement

Represents a Signature Form Element A digital signature (PDF 1.3) may be used to verify the integrity of the document’s contents using verification information related to a signer.

See

https://pspdfkit.com/guides/ios/current/features/digital-signatures/

Declaration

Objective-C


@interface PSPDFSignatureFormElement : PSPDFFormElement

Swift

class SignatureFormElement : FormElement


                      
                      
                      
                      
                      PSPDFSignatureFormField

Represents a signature form field in a PDF form.

Declaration

Objective-C


@interface PSPDFSignatureFormField : PSPDFFormField

Swift

class SignatureFormField : PDFFormField


                      
                      
                      
                      
                      PSPDFTextFieldFormElement

Text field form element.

Declaration

Objective-C


@interface PSPDFTextFieldFormElement : PSPDFFormElement

Swift

class TextFieldFormElement : FormElement


                      
                      
                      
                      
                      PSPDFTextFormField

Represents a text form field in a PDF form. Allows the user to enter custom text.

Declaration

Objective-C


@interface PSPDFTextFormField : PSPDFFormField

Swift

class TextFormField : PDFFormField