FormField.md

FormField

Properties

Name	Type	Description	Notes
alignment	AlignmentEnum	Alignment of the text.	[optional]
assignee	String	Who the field is assigned to. Either a participant set id, null, NOBODY or PREFILL.	[optional]
backgroundColor	String	Background color of the form field in RGB or HEX format	[optional]
borderColor	String	Color of the border of the field in RGB or HEX format	[optional]
borderStyle	BorderStyleEnum	Style of the border of the field.	[optional]
borderWidth	Double	Width of the border of the field in pixels	[optional]
calculated	Boolean	true if this field's value is calculated from an expression, else false	[optional]
conditionalAction	FormFieldConditionalAction	A predicate (or set of predicates) that determines whether this field is visible and enabled.	[optional]
contentType	ContentTypeEnum	Content Type of the form field.	[optional]
defaultValue	String	Default value of the form field	[optional]
displayFormat	String	Format of the value of the field to be displayed based on the displayFormatType property.	[optional]
displayFormatType	DisplayFormatTypeEnum	Format type of the text field.	[optional]
displayLabel	String	Display label attached to the field	[optional]
fontColor	String	Font color of the form field in RGB or HEX format	[optional]
fontName	String	Font name of the form field	[optional]
fontSize	Double	Font size of the form field in points	[optional]
hiddenOptions	List<String>	Text values which are hidden in a drop down form field	[optional]
hyperlink	FormFieldHyperlink	Hyperlink-specific data (e.g. as url, link type)	[optional]
inputType	InputTypeEnum	Input type of the form field	[optional]
locations	List<FormFieldLocation>	All locations in a document where the form field is placed	[optional]
masked	Boolean	true if the input entered by the signer has to be masked (like password), false if it shouldn't be	[optional]
maskingText	String	Text to mask the masked form field	[optional]
maxLength	Integer	Maximum length of the input text field in terms of no. of characters	[optional]
maxValue	Double	Upper bound of the number that can be entered by the signer	[optional]
minLength	Integer	Minimum length of the input text field in terms of no. of characters	[optional]
minValue	Double	Lower bound of the number that can be entered by the signer	[optional]
name	String	The name of the form field	[optional]
origin	OriginEnum	Origin of Form Field	[optional]
radioCheckType	RadioCheckTypeEnum	The type of radio button (if field is radio button, identified by inputType).	[optional]
readOnly	Boolean	true if it is a read-only field, else false	[optional]
required	Boolean	true if it is a mandatory field to be filled by the signer, else false	[optional]
tooltip	String	Text that appears while hovering over the field	[optional]
validation	ValidationEnum	Rule for validating the field value.	[optional]
validationData	String	Further data for validating input with regards to the field's specified format. The contents and interpretation of formatData depends on the value of validation.	[optional]
validationErrMsg	String	Error message to be shown to the signer if filled value doesn't match the validations of the form field	[optional]
valueExpression	String	Expression to calculate value of the form field	[optional]
visible	Boolean	If set to false, then the form field is hidden. Otherwise, it is visible.	[optional]
visibleOptions	List<String>	Text values which are visible in a drop down form field	[optional]

Enum: AlignmentEnum

Name	Value
LEFT	"LEFT"
RIGHT	"RIGHT"
CENTER	"CENTER"

Enum: BorderStyleEnum

Name	Value
SOLID	"SOLID"
DASHED	"DASHED"
BEVELED	"BEVELED"
INSET	"INSET"
UNDERLINE	"UNDERLINE"

Enum: ContentTypeEnum

Name	Value
DATA	"DATA"
SIGNATURE_BLOCK	"SIGNATURE_BLOCK"
SIGNATURE	"SIGNATURE"
SIGNER_NAME	"SIGNER_NAME"
SIGNER_FIRST_NAME	"SIGNER_FIRST_NAME"
SIGNER_LAST_NAME	"SIGNER_LAST_NAME"
SIGNER_INITIALS	"SIGNER_INITIALS"
SIGNER_EMAIL	"SIGNER_EMAIL"
SIGNER_TITLE	"SIGNER_TITLE"
SIGNER_COMPANY	"SIGNER_COMPANY"
SIGNATURE_DATE	"SIGNATURE_DATE"
AGREEMENT_NAME	"AGREEMENT_NAME"
AGREEMENT_MESSAGE	"AGREEMENT_MESSAGE"
TRANSACTION_ID	"TRANSACTION_ID"
SIGNATURE_STAMP	"SIGNATURE_STAMP"
PAYMENT	"PAYMENT"
DIGITAL_SIGNATURE	"DIGITAL_SIGNATURE"

Enum: DisplayFormatTypeEnum

Name	Value
DEFAULT	"DEFAULT"
DATE	"DATE"
NUMBER	"NUMBER"

Enum: InputTypeEnum

Name	Value
TEXT_FIELD	"TEXT_FIELD"
MULTILINE	"MULTILINE"
PASSWORD	"PASSWORD"
RADIO	"RADIO"
CHECKBOX	"CHECKBOX"
DROP_DOWN	"DROP_DOWN"
LISTBOX	"LISTBOX"
SIGNATURE	"SIGNATURE"
PDF_SIGNATURE	"PDF_SIGNATURE"
BUTTON	"BUTTON"
BLOCK	"BLOCK"
FILE_CHOOSER	"FILE_CHOOSER"
COMB	"COMB"
INLINE_IMAGE	"INLINE_IMAGE"
UNSUPPORTED	"UNSUPPORTED"

Enum: OriginEnum

Name	Value
AUTHORED	"AUTHORED"
GENERATED	"GENERATED"
IMPORTED	"IMPORTED"

Enum: RadioCheckTypeEnum

Name	Value
CIRCLE	"CIRCLE"
CHECK	"CHECK"
CROSS	"CROSS"
DIAMOND	"DIAMOND"
SQUARE	"SQUARE"
STAR	"STAR"

Enum: ValidationEnum

Name	Value
NONE	"NONE"
STRING	"STRING"
NUMBER	"NUMBER"
DATE	"DATE"
DATE_CUSTOM	"DATE_CUSTOM"
TIME	"TIME"
ZIP	"ZIP"
PHONE	"PHONE"
SOCIAL_SEC	"SOCIAL_SEC"
EMAIL	"EMAIL"
CURRENCY	"CURRENCY"
PERCENT	"PERCENT"
FORMULA	"FORMULA"
CUSTOM	"CUSTOM"
XFA_PICTURE	"XFA_PICTURE"