Public Types | |
enum | Flags { Flags.e_FlagReadOnly = 0x01, Flags.e_FlagRequired = 0x02, Flags.e_FlagNoExport = 0x04, Flags.e_FlagButtonNoToggleToOff = 0x100, Flags.e_FlagButtonRadiosInUnison = 0x200, Flags.e_FlagTextMultiline = 0x100, Flags.e_FlagTextPassword = 0x200, Flags.e_FlagTextDoNotScroll = 0x400, Flags.e_FlagTextComb = 0x800, Flags.e_FlagComboEdit = 0x100, Flags.e_FlagChoiseMultiSelect = 0x100 } |
Enumeration for form field flags. More... | |
enum | Type { Type.e_TypeUnknown = 0, Type.e_TypePushButton = 1, Type.e_TypeCheckBox = 2, Type.e_TypeRadioButton = 3, Type.e_TypeComboBox = 4, Type.e_TypeListBox = 5, Type.e_TypeTextField = 6, Type.e_TypeSignature = 7 } |
Enumeration for form field type. More... | |
Public Member Functions | |
Field (PDFDoc document, PDFDictionary field_dict) | |
Constructor, from field dictionary. More... | |
Field (Field field) | |
Constructor, with another Field object. | |
Alignment | GetAlignment () |
Get the alignment value. More... | |
string | GetAlternateName () |
Get alternate name. More... | |
Control | GetControl (int index) |
Get a form control by index. More... | |
Control | GetControl (PDFPage page, int index) |
Get a form control by index, in a specified PDF page. More... | |
int | GetControlCount () |
Get count of form controls. More... | |
int | GetControlCount (PDFPage page) |
Get count of form controls in a specified PDF page. More... | |
DefaultAppearance | GetDefaultAppearance () |
Get the default appearance data. More... | |
string | GetDefaultValue () |
Get default value. More... | |
PDFObject | GetDefaultValueObj () |
Get the PDF object of field's default value. More... | |
PDFDictionary | GetDict () |
Get the PDF dictionary of current object. More... | |
int | GetFlags () |
Get field flags. More... | |
PDFObject | GetInheritedAttribute (string attribute_name) |
Get the PDF object for specified attribute which may be inherited from the ancestor node in the field tree. More... | |
string | GetMappingName () |
Get mapping name. More... | |
int | GetMaxLength () |
Get maximum length of the field's text, in characters. More... | |
string | GetName () |
Get field name. More... | |
ChoiceOptionArray | GetOptions () |
Get options of list box or combo box. More... | |
int | GetTopVisibleIndex () |
Get top index of option for scrollable list boxes. More... | |
Field.Type | GetType () |
Get field type. More... | |
string | GetValue () |
Get value. More... | |
PDFObject | GetValueObj () |
Get the PDF object of field's value. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | Reset () |
Reset data in current field to its default value. (Not support signature field) More... | |
void | SetAlignment (Alignment alignment) |
Set alignment property of a form, as a document-wide default value. (Not support signature field) More... | |
void | SetAlternateName (string alternate_name) |
Set alternate name. (Not support signature field) More... | |
void | SetDefaultAppearance (DefaultAppearance default_ap) |
Set default appearance data. More... | |
void | SetDefualtValue (string value) |
Set default value. More... | |
void | SetFlags (int flags) |
Set field flags. More... | |
void | SetMappingName (string name) |
Set mapping name. (Not support signature field) More... | |
void | SetMaxLength (int max_length) |
Set maximum length of the field's text, in characters. More... | |
void | SetOptions (ChoiceOptionArray option_array) |
Set options of list box or combo box. More... | |
void | SetTopVisibleIndex (int index) |
Set top index for scrollable list boxes. More... | |
void | SetValue (string value) |
Set value. More... | |
In a PDF document, form fields appear on any combination of pages and all of them make up a single, global interactive form spanning the entire document. Function Form::GetField can use to get a form field from interactive form. This class offers functions to get some information/properties of a form field, reset the form field to its default value, and get form control from form field.
When a form fiels's type is e_TypeSignature, the form field object is a Signature object in fact.
To access additional actions, please construct an actions::AdditionalAction object with Field object.
|
strong |
Enumeration for form field flags.
Values of this enumeration can be used alone or in a combination.
|
strong |
Enumeration for form field type.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
e_TypeUnknown | Form field type: unknown. |
e_TypePushButton | Form field type: push button. |
e_TypeCheckBox | Form field type: check box. |
e_TypeRadioButton | Form field type: radio button. |
e_TypeComboBox | Form field type: combo box. |
e_TypeListBox | Form field type: list box. |
e_TypeTextField | Form field type: text field. |
e_TypeSignature | Form field type: signature field. |
|
inline |
Constructor, from field dictionary.
document | A valid PDF document. |
field_dict | A PDF dictionary which represents a form field. It should belong to the PDF document specified by parameter document; |
|
inline |
Get the alignment value.
Alignment is a property for variable text and it is only useful for text field and list box, which may contain variable text as their content.
If a text field or list box has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used for the text field or list box.
|
inline |
Get alternate name.
An alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
|
inline |
Get a form control by index.
index | Form control index. Valid range: from 0 to (count-1). count is returned by function Field::GetControlCount. |
Get a form control by index, in a specified PDF page.
page | A valid PDFPage object. It should be in the same document as current form field. |
index | Form control index. Valid range: from 0 to (count-1). count is returned by function Field::GetControlCount with same parameter page. |
|
inline |
Get count of form controls.
|
inline |
Get count of form controls in a specified PDF page.
page | A valid PDFPage object. It should be in the same document as current form field. |
|
inline |
Get the default appearance data.
|
inline |
Get default value.
Applicable for all fields except push button. For field types that are not applicable, an empty string will be returned.
|
inline |
Get the PDF object of field's default value.
The format of field's default value varies depending on the field type. For more details, please refer to "TABLE 8.69
Entries common to all field dictionaries" in <PDF reference 1.7> P676.
|
inline |
Get the PDF dictionary of current object.
|
inline |
|
inline |
Get the PDF object for specified attribute which may be inherited from the ancestor node in the field tree.
Some of the field attributes are designated as inheritable, such as "Ff", "V", "DV", and so on. Please refer to "TABLE 8.69 Entries common to all field dictionaries" in <PDF Reference 1.7> P675.
attribute_name | The name of attribute to be found. |
|
inline |
Get mapping name.
Mapping name is to be used when exporting interactive form field data from the document.
|
inline |
Get maximum length of the field's text, in characters.
Applicable for text fields. For field types that are not applicable, this function will return 0.
|
inline |
Get field name.
|
inline |
Get options of list box or combo box.
Applicable for list box and combo box. For field types that are not applicable, this function will return an empty array.
|
inline |
Get top index of option for scrollable list boxes.
Applicable for list box. For field types that are not applicable, this function will return 0.
Top index of option is the the index of the first option visible in the list.
|
inline |
Get field type.
|
inline |
Get value.
Applicable for all fields except push button. For field types that are not applicable, an empty string will be returned.
|
inline |
Get the PDF object of field's value.
The format of field's value varies depending on the field type. For more details, please refer to "TABLE 8.69 Entries
common to all field dictionaries" in <PDF reference 1.7> P676.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Reset data in current field to its default value. (Not support signature field)
|
inline |
Set alignment property of a form, as a document-wide default value. (Not support signature field)
Alignment is a property for variable text and it is only useful for text field and list box, which may contain variable text as their content.
If a text field or list box has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used for the text field or list box.
If current form field is a signature field, this function will do nothing.
alignment | The new default alignment type of variable text. Please refer to e_AlignmentXXX values and it should be one of these values. If other values is used to set, e_AlignmentLeft will be used by default. |
|
inline |
Set alternate name. (Not support signature field)
An alternate field name is to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
If current form field is a signature field, this function will do nothing.
alternate_name | A new alternate name string. It should not be an empty string. |
|
inline |
Set default appearance data.
default_ap | The new default appearance.pdf::DefaultAppearance::SetFlags can be used to decide which information is/are to be updated with the new data; for those no updated data, they will keep to use old data. |
|
inline |
Set default value.
Applicable for all fields except push button. For field types that are not applicable, this function will do nothing.
value | New default value string. It should not be an empty string. |
|
inline |
Set field flags.
Field flags specifies various characteristics of a form field.
flags | New form field flags. Please refer to e_FlagXXX values and it would be one of a combination of these values. |
|
inline |
Set mapping name. (Not support signature field)
Mapping name is to be used when exporting interactive form field data from the document. If current form field is a signature field, this function will do nothing.
name | New mapping name string.It should not be an empty string. |
|
inline |
Set maximum length of the field's text, in characters.
Applicable for text fields. For field types that are not applicable, this function will do nothing.
max_length | New maximum length of the field's text. It should be non-negative. |
|
inline |
Set options of list box or combo box.
Applicable for list box and combo box. For field types that are not applicable, this function will do nothing.
option_array | An array of options which is to be set to list box or combo box. |
|
inline |
Set top index for scrollable list boxes.
Applicable for list box. For field types that are not applicable, this function will do nothing.
Top index of option is the the index of the first option visible in the list.
index | The index of the first option visible in the list. |
|
inline |
Set value.
Applicable for all fields except push button. For field types that are not applicable, this function will do nothing.
Specially, for combo box and text field, when setting value successfully, this function will also trigger related calculation and formatting events and update the appearance of the field.
value | New value string. It should not be an empty string. Specially, when current field is a list box field, this parameter can contain multiple values: When to set multiple values, each value should be wrapped by "()". For example, "(ABC)(CCC)" means to set 2 value "ABC" and "CCC". If a value contains "()", or "\\" as its content, please add an additional "\\" as an escape character just in front of each character of "()" or "\\". For example: "ABC" means to set the value "ABC". "(ABC)" means to set the value "ABC". "(ABC" means to set the value "(ABC". "(\\\\(ABC\\\\)\\\\(BBB\\\\)\\\\(CCC\\\\))" means to set the value "(ABC)(BBB)(CCC)". "456\\\\\\\\" means to set the value "456\\". "(\\\\(ABC\\\\))" means to set the value "(ABC)". |