constant

Enumerations
enum	Field_Flag {   ReadOnly = 1, Required = 2, NoExport = 4 , ButtonNoToggleToOff = 16384,   ButtonRadiosInUnison = 33554432, TextMultiline = 4096, TextPassword = 8192, TextDoNotSpellCheck = 4194304,   TextDoNotScroll = 8388608, TextComb = 16777216, ComboEdit = 262144, ChoiceMultiSelect = 2097152,   CommitOnSelChange = 67108864 }
	Enumeration for PDF Form Field flags. More...
enum	Field_Type {   Unknown = 0, PushButton = 1, CheckBox = 2, RadioButton = 3,   Text = 6, ListBox = 5, ComboBox = 4, Sign = 7,   Barcode = 8 }
	Enumeration for PDF Form Field type. More...
enum	FieldCalculateType { NOT_CALCULATED = 0, CALCULATE_WITH_FIELDS = 1, FIMPLIFIED_FIELD_NOTATION = 2, CUSTOM_CALCULATE_SCRIPT = 3 }
	The type of calculate info for a field. More...
enum	FieldFlag {   ReadOnly = 1, Required = 2, NoExport = 4 , ButtonNoToggleToOff = 16384,   ButtonRadiosInUnison = 33554432, TextMultiline = 4096, TextPassword = 8192, TextDoNotSpellCheck = 4194304,   TextDoNotScroll = 8388608, TextComb = 16777216, ComboEdit = 262144, ChoiceMultiSelect = 2097152,   CommitOnSelChange = 67108864 }
	Enumeration for PDF Form Field flags. More...
enum	FieldType {   Unknown = 0, PushButton = 1, CheckBox = 2, RadioButton = 3,   Text = 6, ListBox = 5, ComboBox = 4, Sign = 7,   Barcode = 8 }
	Enumeration for PDF Form Field type. More...
enum	FormatCategory {   NONE = 'none', NUMBER = 'number', PERCENTAGE = 'percentage', DATE = 'date',   TIME = 'time', SPECIAL = 'special', CUSTOM = 'custom' }
	Format categories for PDF form field format actions. More...
enum	FormWidgetRotation {   ROTATION_0 = 0, ROTATION_90 = 1, ROTATION_180 = 2, ROTATION_270 = 3,   UNKNOWN = 4 }
	The rotation of a widget. More...
enum	MDPActionType {   NONE = 'none', ALL = 'all', INCLUDE = 'include', EXCLUDE = 'exclude',   CUSTOM = 'custom' }
	MDP (Modification Detection and Prevention) action types for PDF form fields. More...
enum	Signature_Type { ordinary = 0, pagingSeal = 4 }
	Enumeration for PDF signature type. More...
enum	SpecialFormatEnum { ZIP_CODE = 0, ZIP_CODE_4 = 1, PHONE_NUMBER = 2, SOCIAL_SECURITY_NUMBER = 3 }
	Enum for special formats such as zip code or phone number. More...
enum	TimeFormatEnum { HH_MM = 0, h_MM_tt = 1, HH_MM_ss = 2, h_MM_ss_tt = 3 }
	Enum for time format. More...
enum	ValidateTypeEnum { NONE = 'none', RANGE = 'range', CUSTOM = 'custom' }
	Validation type enumeration for form fields. More...

Detailed Description

pdf related constants

Enumeration Type Documentation

Field_Flag

enum Field_Flag

Enumeration for PDF Form Field flags.

Since

7.1.0

Enumerator
ReadOnly	ReadOnly flag's bit position.
Required	Required flag's bit position.
NoExport	NoExport flag's bit position.
ButtonNoToggleToOff	ButtonNoToggleToOff flag's bit position. Note Only for radio button
ButtonRadiosInUnison	ButtonRadiosInUnison flag's bit position. Note Only for radio button
TextMultiline	TextMultiline flag's bit position. Note Only for text field
TextPassword	TextPassword flag's bit position. Note Only for text field
TextDoNotSpellCheck	TextDoNotSpellCheck flag's bit position. Note Only for text field
TextDoNotScroll	TextDoNotScroll flag's bit position. Note Only for text field
TextComb	TextComb flag's bit position. Note Only for text field
ComboEdit	ComboEdit flag's bit position. Note Only for combo box
ChoiceMultiSelect	ChoiceMultiSelect flag's bit position. Note Only for list box
CommitOnSelChange	CommitOnSelChange flag's bit position.

Field_Type

enum Field_Type

Enumeration for PDF Form Field type.

Since

7.1.0

Enumerator
Unknown	unsupported or invalid field.
PushButton	push button without any value.
CheckBox	check box with on/off states.
RadioButton	a group of radio buttons, at most one item can be selected.
Text	single line or multi-line texts.
ListBox	list box, single or multiple selections.
ComboBox	combo box with or without the edit box.
Sign	signature field.
Barcode	barcode field.

FieldCalculateType

enum FieldCalculateType

The type of calculate info for a field.

Since

11.0.0

Enumerator
NOT_CALCULATED	The field is not calculated.
CALCULATE_WITH_FIELDS	The field is calculated based on the values of other fields.
FIMPLIFIED_FIELD_NOTATION	The field is calculated using a Simplified Field Notation.
CUSTOM_CALCULATE_SCRIPT	The field is calculated using a custom JavaScript script.

FieldFlag

enum FieldFlag

Enumeration for PDF Form Field flags.

Since

7.1.0

Enumerator
ReadOnly	If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.
Required	If set, the field must have a value at the time it is exported by a submit-form action.
NoExport	If set, the field must not be exported by a submit-form action.
ButtonNoToggleToOff	(Only useful for radio button) If set, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected. Note Only for radio button
ButtonRadiosInUnison	(Only useful for radio button) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive. Note Only for radio button
TextMultiline	(Only useful for text field) If set, the text field can contain multiple lines of text; if clear, the field's text is restricted to a single line. Note Only for text field
TextPassword	(Only useful for text field) If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. Note To protect password confidentiality, viewer applications should never store the value of the text field in the PDF file if this flag is set. Only for text field.
TextDoNotSpellCheck	(Only useful for text field) If set, text entered in the field is not spell-checked. Note Only for text field
TextDoNotScroll	(Only useful for text field) If set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted. Note Only for text field
TextComb	(Only useful for text field) If set, the field is automatically divided into as many equally spaced positions, or combs, as the value of maximum length of a field's text, and the text is laid out into those combs. Note Only for text field
ComboEdit	(Only useful for combo box) If set, the combo box includes an editable text control with a drop-down list, if clear, it includes only a drop-down list. Note Only for combo box
ChoiceMultiSelect	(Only useful for list box) If set, more than one items may be selected simultaneously; if clear, no more than one item at a time may be selected. Note Only for list box
CommitOnSelChange	If set, the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field.

FieldType

enum FieldType

Enumeration for PDF Form Field type.

Since

11.0.0

Enumerator
Unknown	unsupported or invalid field.
PushButton	push button without any value.
CheckBox	check box with on/off states.
RadioButton	a group of radio buttons, at most one item can be selected.
Text	single line or multi-line texts.
ListBox	list box, single or multiple selections.
ComboBox	combo box with or without the edit box.
Sign	signature field.
Barcode	barcode field.

FormatCategory

enum FormatCategory

Format categories for PDF form field format actions.

Since

11.0.0

Enumerator
NONE	No format is applied.
NUMBER	Number format.
PERCENTAGE	Percentage format.
DATE	Date format.
TIME	Time format.
SPECIAL	Special format, such as a zip code or phone number.
CUSTOM	Custom format, specified by a JavaScript expression.

FormWidgetRotation

enum FormWidgetRotation

The rotation of a widget.

FormWidgetRotation is an enumeration that represents the rotation of a widget.

Since

11.0.0

Enumerator
ROTATION_0	No rotation.
ROTATION_90	Rotate 90 degrees clockwise.
ROTATION_180	Rotate 180 degrees clockwise.
ROTATION_270	Rotate 270 degrees clockwise.
UNKNOWN	Unknown rotation.

MDPActionType

enum MDPActionType

MDP (Modification Detection and Prevention) action types for PDF form fields.

These types represent the different options for MDP actions that can be applied to form fields, such as all, include, exclude, or custom MDP actions.

Since

11.0.0

Enumerator
NONE	No MDP action is applied.
ALL	Applies MDP action to all fields.
INCLUDE	Includes specific fields for MDP action.
EXCLUDE	Excludes specific fields from MDP action.
CUSTOM	Custom MDP action defined by JavaScript.

Signature_Type

enum Signature_Type

Enumeration for PDF signature type.

Since

11.0.0

Enumerator
ordinary	Ordinary signature.
pagingSeal	Paging seal signature.

SpecialFormatEnum

enum SpecialFormatEnum

Enum for special formats such as zip code or phone number.

Since

11.0.0

Enumerator
ZIP_CODE	Standard 5-digit zip code.
ZIP_CODE_4	Zip code with 4 extra digits.
PHONE_NUMBER	Standard phone number format.
SOCIAL_SECURITY_NUMBER	Social security number format.

TimeFormatEnum

enum TimeFormatEnum

Enum for time format.

Since

11.0.0

Enumerator
HH_MM	HH:MM, 24-hour format, e.g. 12:34.
h_MM_tt	h:MM tt, 12-hour format, e.g. 12:34 PM
HH_MM_ss	HH:MM:ss, 24-hour format with seconds, e.g. 12:34:56.
h_MM_ss_tt	h:MM:ss tt, 12-hour format with seconds, e.g. 12:34:56 PM

ValidateTypeEnum

enum ValidateTypeEnum

Validation type enumeration for form fields.

This enumeration represents the types of validation that can be applied to form fields, including no validation, range validation, and custom JavaScript validation.

Since

11.0.0

Enumerator
NONE	No validation is applied.
RANGE	Validation is based on a range of values.
CUSTOM	Validation is based on a custom JavaScript expression.