PSPDFTextFieldFormElement

Objective-C


@interface PSPDFTextFieldFormElement : PSPDFFormElement

Swift

class TextFieldFormElement : FormElement

A form element in which a user can enter text.

  • If set, the field may contain multiple lines of text; if clear, the field’s text shall be restricted to a single line.

    Declaration

    Objective-C

    @property (readonly, getter=isMultiline) BOOL multiline;

    Swift

    var isMultiline: Bool { get }

  • If set, the field is intended for entering a secure password that should not be echoed visibly to the screen.

    Declaration

    Objective-C

    @property (readonly, getter=isPassword) BOOL password;

    Swift

    var isPassword: Bool { get }

  • Returns the contents formatted based on rules set on the form field (including JavaScript).

    Declaration

    Objective-C

    @property (readonly, nullable) NSString *formattedContents;

    Swift

    var formattedContents: String? { get }

  • The input format. Some forms are number/date/time specific.

    Declaration

    Objective-C

    @property (readonly) PSPDFTextInputFormat inputFormat;

    Swift

    var inputFormat: TextFieldFormElement.TextInputFormat { get }

  • This is equivalent to the formField property from the superclass but with the more specific type TextFormField.

    Declaration

    Objective-C

    @property (readonly, nullable) PSPDFTextFormField *textFormField;

    Swift

    var textFormField: PSPDFTextFormField? { get }