Forms

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

    See more

    Declaration

    Objective-C

    
    @interface PSPDFButtonFormElement : PSPDFFormElement <NSSecureCoding>

    Swift

    class ButtonFormElement : FormElement, NSSecureCoding
  • 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.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFButtonFormField : PSPDFFormField

    Swift

    class ButtonFormField : PDFFormField
  • Choice Form Element.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFChoiceFormElement : PSPDFFormElement

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface PSPDFChoiceFormField : PSPDFFormField

    Swift

    class ChoiceFormField : PDFFormField
  • Represents a PDF form element.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFFormElement : PSPDFWidgetAnnotation <NSSecureCoding>

    Swift

    class FormElement : WidgetAnnotation, NSSecureCoding
  • 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 PSPDFDocument or PSPDFDocumentProvider.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFFormField : PSPDFModel <PSPDFUndoSupport, NSSecureCoding>

    Swift

    class PDFFormField : ModelObject, UndoSupport, NSSecureCoding
  • Undocumented

    See more

    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
  • Parses PDF Forms (“AcroForms”). This will not create objects based on the (soon deprecated) XFA standard.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFFormParser : NSObject <PSPDFOverridable>

    Swift

    class PDFFormParser : NSObject, Overridable
  • Signature Form Element.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFSignatureFormElement : PSPDFFormElement

    Swift

    class SignatureFormElement : FormElement
  • Represents a signature form field in a PDF form.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFSignatureFormField : PSPDFFormField

    Swift

    class SignatureFormField : PDFFormField
  • Text field form element.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFTextFieldFormElement : PSPDFFormElement

    Swift

    class TextFieldFormElement : FormElement
  • Represents a text form field in a PDF form. Allows the user to enter custom text.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFTextFormField : PSPDFFormField

    Swift

    class TextFormField : PDFFormField
  • Buttons / choice form views.

    Declaration

    Objective-C

    
    @interface PSPDFButtonFormElementView : PSPDFFormElementView <PSPDFOverridable>

    Swift

    class ButtonFormElementView : PDFFormElementView, Overridable
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface PSPDFChoiceFormElementView : PSPDFFormElementView <PSPDFOverridable>

    Swift

    class ChoiceFormElementView : PDFFormElementView, Overridable
  • Models a request to submit a form in a PDF document to a remove server.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFFormRequest : NSObject

    Swift

    class PDFFormRequest : NSObject
  • Delegate for form submission actions. When a form submission action is run, the delegate will be queried in this order:

    1. formSubmissionController:shouldPresentWebViewForResponseData: – should the view controller push a web view with the response data. If yes then the web view takes responsibility for the connection and call 4 is not made.
    2. formSubmissionController:shouldSubmitFormValues: – if no then the operation is cancelled.
    3. formSubmissionController:willSubmitFormValues: – the submission is going ahead. 4.a formSubmissionController:didReceiveResponseData: – the submission has completed successfully OR 4.b formSubmissionController:didFailWithError: – the submission has failed
    See more

    Declaration

    Objective-C

    @protocol PSPDFFormSubmissionDelegate <NSObject>

    Swift

    protocol PDFFormSubmissionDelegate : NSObjectProtocol
  • Free Text View. Allows inline text editing.

    See more

    Declaration

    Objective-C

    
    @interface PSPDFTextFieldFormElementView
        : PSPDFFormElementView <UITextViewDelegate, UITextFieldDelegate,
                                PSPDFOverridable>

    Swift

    class TextFieldFormElementView : PDFFormElementView, UITextViewDelegate, UITextFieldDelegate, Overridable