Fields

Field represents and interactive control within InteractiveFormHandle. More...

Classes
class	FieldCollectionHandle
	Collection of FieldHandle. More...
class	FieldHandle
	Base class for all fields. More...
class	NonTerminalFieldHandle
	Many field attributes are inheritable, meaning that if they are not explicitly specified for a given field, their values are taken from those of its parent in the field hierarchy. More...
class	ButtonFieldHandle
	A button field represents an interactive control on the screen that the user can manipulate with the mouse. More...
class	TextFieldHandle
	A text field is a box or space for text fill-in data typically entered from a keyboard. More...
class	ChoiceFieldHandle
	A choice field contains several text items, one or more of which shall be selected as the field value. More...
class	SignatureFieldHandle
	A signature field (PDF 1.3) is a form field that contains a digital signature. More...

Enumerations
enum	FieldType {   FieldType_Undefined = 0 , FieldType_NonTerminal , FieldType_Button , FieldType_Text ,   FieldType_Choice , FieldType_Signature }
	Available types of fields. More...
enum	FieldFlags {   FieldFlags_None = 0 , FieldFlags_ReadOnly = (1 << 0) , FieldFlags_Required = (1 << 1) , FieldFlags_NoExport = (1 << 2) ,   FieldFlags_Radio = (1 << 15) , FieldFlags_PushButton = (1 << 16) , FieldFlags_Multiline = (1 << 12) , FieldFlags_Password = (1 << 13) ,   FieldFlags_Combo = (1 << 17) , FieldFlags_Edit = (1 << 18) , FieldFlags_Sort = (1 << 19) }
	Bit flags common to all field types (PDF 32000-1:2008, Table 221) More...

Detailed Description

Field represents and interactive control within InteractiveFormHandle.

For more details please visit section 12.7.3 - Field Dictionaries and section 12.7.4 - Field Types.

Enumeration Type Documentation

FieldType

enum FieldType

Available types of fields.

Enumerator
FieldType_NonTerminal	Many field attributes are inheritable, meaning that if they are not explicitly specified for a given field, their values are taken from those of its parent in the field hierarchy. See also NonTerminalFieldHandle
FieldType_Button	A button field represents an interactive control on the screen that the user can manipulate with the mouse. See also ButtonFieldHandle
FieldType_Text	A text field is a box or space for text fill-in data typically entered from a keyboard. See also TextFieldHandle
FieldType_Choice	A choice field contains several text items, one or more of which shall be selected as the field value. See also ChoiceFieldHandle
FieldType_Signature	A signature field (PDF 1.3) is a form field that contains a digital signature. See also SignatureFieldHandle

FieldFlags

enum FieldFlags

Bit flags common to all field types (PDF 32000-1:2008, Table 221)

Enumerator
FieldFlags_ReadOnly	The user may not change the value of the field.
FieldFlags_Required	The field shall have a value before the form can be submitted.
FieldFlags_NoExport	The field shall not be exported by a submit-form action.
FieldFlags_Radio	The field is a set of radio buttons (otherwise checkbox if button type)
FieldFlags_PushButton	The field is a push button that does not retain a permanent value.
FieldFlags_Multiline	The field may contain multiple lines of text.
FieldFlags_Password	The field is intended for entering a secure password.
FieldFlags_Combo	The choice field is a combo box (otherwise list box)
FieldFlags_Edit	The combo box includes an editable text box.
FieldFlags_Sort	The field options shall be sorted alphabetically.