signoAPI iOS – STFormFieldInfoDTO class

The STFormFieldInfoDTO class is a data object that contains the common properties of a form field. This class has the subclasses STSignatureFieldInfoDTO and STEditableFieldInfoDTO. The class is part of libSignoPDFSigner.

Property

Description

@property(nonatomic,strong) NSString *name

Property	Description
NSString* name	-
Return value	Description
-	-

Name of the form field

@property CGRect rectangle

Property	Description
CGRect rectangle	-
Return value	Description
-	-

Position specification of the form field

@property int page

Property	Description
int page	-
Return value	Description
-	-

Page on which the form field is located. The first page number of the document begins with 1.

@property FormFieldType type

Property	Description
FormFieldType type	-
Return value	Description
-	-

Type of form field

@property BOOL isRequired

Property	Description
BOOL isRequired	-
Return value	Description
-	-

YES, if the field is a mandatory field; otherwise, NO

FormFieldType is an enumeration type defined with typedef enum that describes different types of form fields. It contains the following values:

Property	Description
Text	Text form field
Button	Checkbox or radio button
Choice	Dropdown field
Signature	Signature field

This class also contains a bitmask type (NSUInteger) defined with NS_OPTIONS with the name FormFieldTypeOptions, which represents the combinable types of form fields. It allows the simultaneous selection of several field types by logical OR linking (|).

Property	Description
FormFieldTypeText	Text form field (1 << 0)
FormFieldTypeButton	Checkbox or radio button (1 << 1)
FormFieldTypeChoice	Drop-down field (1 << 2)
FormFieldTypeSignature	Signature field (1 << 3)
FormFieldTypeEditableFields	Combination of FormFieldTypeText, FormFieldTypeButton and FormFieldTypeChoice
FormFieldTypeAll	Combination of all available field types