Public Member Functions | |
Form (PDFDoc document) | |
Constructor, with PDF document. More... | |
Form (Form other) | |
Constructor, with another Form object. | |
Control | AddControl (PDFPage page, string field_name, Field.Type field_type, RectF rect) |
Add a new form control to a specified form field. If the form field does not exist, this function will add a form field as well. (Not support signature field) More... | |
bool | ExportToXML (string file_path) |
Export the form data to an XML file. More... | |
Alignment | GetAlignment () |
Get the alignment value which is used as document-wide default value. More... | |
Control | GetControl (PDFPage page, int index) |
Get a form control by index, in a specified PDF page. More... | |
Control | GetControlAtDevicePoint (PDFPage page, PointF point, float tolerance, Field.Type type, Matrix2D matrix) |
Get the form control at a specified position, in device coordination system. More... | |
Control | GetControlAtPoint (PDFPage page, PointF point, float tolerance, Field.Type type) |
Get the form control at a specified position, in PDF coordinate system . More... | |
int | GetControlCount (PDFPage page) |
Get count of form controls in a specified PDF page. More... | |
DefaultAppearance | GetDefaultAppearance () |
Get the default appearance data. More... | |
PDFDictionary | GetDict () |
Get the dictionary of current object. More... | |
PDFDoc | GetDocument () |
Get the PDF document, with which current form object is associated. More... | |
Field | GetField (int index, string filter) |
Get a form field by index, whose names satisfy the specified name filter. More... | |
int | GetFieldCount (string filter) |
Get the count of form fields, whose names satisfy the specified name filter. More... | |
FieldArray | GetFieldsInCalculationOrder () |
Get an array of form fields in calculation order. More... | |
Filler | GetFormFiller () |
Get the form filler. More... | |
bool | ImportFromXML (string file_path) |
Import the form data from an XML file. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | NeedConstructAppearances () |
Check whether to construct appearance when loading form controls. More... | |
void | RemoveControl (Control control) |
Remove a form control. (Not support to remove a form control from a signature field) More... | |
void | RemoveField (Field field) |
Remove a form field. (Not support signature field) More... | |
bool | RenameField (Field field, string new_field_name) |
Rename a field with a new name. More... | |
bool | Reset () |
Reset data of all fields (except signature fields) to their default value. More... | |
void | SetAlignment (Alignment alignment) |
Set alignment value which is used as document-wide default value. More... | |
void | SetConstructAppearances (bool need_construct) |
Set a flag that specifies whether to construct appearances when loading form controls. More... | |
void | SetDefaultAppearance (DefaultAppearance default_ap) |
Set default appearance data. More... | |
void | SetFieldsInCalculationOrder (FieldArray field_array) |
Set an array of form fields in calculation order. More... | |
bool | ValidateFieldName (Field.Type type, string field_name) |
Validate whether a field name can be used for a new field in specified field type. More... | |
An interactive form – sometimes referred to as an AcroForm – is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document. Arbitrary subsets of these fields can be imported or exported from the document.
Function pdf::PDFDoc::HasForm can be used to judge if a PDF document has interactive form.
A Form object can be constructed form a specified PDF document. This class offers functions to retrieve form fields or form controls, import/export form data and other features. For example:
To retrieve form fields, please use functions Form::GetFieldCount and Form::GetField.
To retrieve form controls from a PDF page, please use functions Form::GetControlCount and Form::GetControl.
To import form data from an XML file, please use function Form::ImportFromXML; to export form data to an XML file, please use function Form::ExportToXML.
To retrieve form filler object, please use function Form::GetFormFiller.
To import form data from a FDF/XFDF file or export such data to a FDF/XFDF file, please refer to functions pdf::PDFDoc::ImportFromFDF and pdf::PDFDoc::ExportToFDF.
To fill the form, please construct a Filler object by current Form object or retrieve the Filler object by function Form::GetFormFiller if such object has been constructed. (There should be only one form filler object for an interactive form).
|
inline |
Constructor, with PDF document.
If PDF document does not have AcroForm, this constructor will add an empty AcroForm to the PDF document in order that new fields can be added to the PDF document later.
document | A valid PDF document. |
|
inline |
Add a new form control to a specified form field. If the form field does not exist, this function will add a form field as well. (Not support signature field)
Application can use this function to add a new form control:
If the specified form field exists, a new form control will be created and set to the field.
If the specified form field does not exist, a new form field will be created according to parameter field_name and field_type and added to form, along with a newly created form control.
Whether a form field exists or not, it will be judged with input parameters field_name and field_type.
If user wants to add a new signature field, please use function pdf::PDFPage::AddSignature instead of current function.
The newly added form control has no appearance, so user should use setting methods in class Control or in related Field or Widget to set properties which will affect appearance. Some setting methods of class Control and Field may directly update appearance, but function annots::Widget::ResetAppearanceStream of related widget annotation is still recommended to be called to ensure the appearance will indeed be updated.
For push button, check box, radio button, if user calls function annots::Annot::ResetAppearanceStream directly without setting any properties, the default appearance style will be used:
push button: In related widget annotation, background color (in the MK dictionary) = 0xC0C0C0, highlighting mode = e_HighlightingPush.
check box/radio button: In related widget annotation, border width = 1.0, border style = e_Solid, background color (in the MK dictionary) = 0xFFFFFF, border color (in the MK dictionary) = 0xFFFFFF.
page | A valid PDF page, in which the new form control will be added. It should belong to the same PDF document as current form. |
field_name | Field name. |
field_type | Field type. Please refer to e_TypeXXX values and this should be one of these values except e_TypeXXX value. If this is e_TypeSignature, this function will throw exception {}. |
rect | Rectangle of the new form control which specifies the position in PDF page. It should be in PDF coordinate system . |
|
inline |
Export the form data to an XML file.
file_path | A full file_path of an XML file. This specifies the XML file that form data will be exported to. |
|
inline |
Get the alignment value which is used as document-wide default value.
Alignment is a property for variable text. It is only applicable 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 value will be used for the text field or list box.
Get a form control by index, in a specified PDF page.
page | A valid PDFPage object. It should belong to the same PDF document as current form. |
index | Index of form control to be retrieved. Valid range: from 0 to (count-1). count is returned by function Field::GetControlCount with same parameter page. |
|
inline |
Get the form control at a specified position, in device coordination system.
page | A valid PDFPage object. It should be in the same document as current form. |
point | A position, in device coordinate system. |
tolerance | Tolerance value. Valid range: 0.0f to 30.0f. |
type | The field type whose form control will be retrieved. Please refer to e_TypeXXX values and it should be one of these values. e_TypeUnknown means not to care about the field type and just to retrieve the first form control at the specified position. |
matrix | A transformation matrix. Usually this is returned by function pdf::PDFPage::GetDisplayMatrix. If this is null, current function will have the same feature as function Form::GetControlAtPoint. |
|
inline |
Get the form control at a specified position, in PDF coordinate system .
page | A valid PDFPage object. It should be in the same document as current form. |
point | A position, in PDF coordinate system . |
tolerance | Tolerance value. Valid range: 0.0f to 30.0f. |
type | The field type whose form control will be retrieved. Please refer to e_TypeXXX values and it should be one of these values. e_TypeUnknown means not to care about the field type and just to retrieve the first form control at the specified position. |
|
inline |
Get count of form controls in a specified PDF page.
page | A valid PDFPage object. It should belong to the same PDF document as current form. |
|
inline |
Get the default appearance data.
|
inline |
Get the dictionary of current object.
|
inline |
Get the PDF document, with which current form object is associated.
|
inline |
Get a form field by index, whose names satisfy the specified name filter.
index | Index of form field to be retrieved. Valid range: from 0 to (count-1). count is returned by function Form::GetFieldCount with same parameter filter. |
filter | A filter string. If this is an empty string, that means to count all form fields; if this is valid, that means to count those form fields whose names are partially matched parameter filter. For example, if parameter filter is "text1", the filter will match text1.0, text1.2.0, etc; but not match test10 or test11.1. |
|
inline |
Get the count of form fields, whose names satisfy the specified name filter.
filter | A filter string. If this is an empty string, that means to count all form fields; if this is valid, that means to count those form fields whose names are partially matched parameter filter. For example, if parameter filter is "text1", the filter will match text1.0, text1.2.0, etc; but not match test10 or test11.1. |
|
inline |
Get an array of form fields in calculation order.
The calculation order defines the order in which the values of fields will be recalculated when value of any field is changed. Usually, these fields have calculation actions.
|
inline |
Get the form filler.
|
inline |
Import the form data from an XML file.
file_path | A full file_path of an existing XML file. This specifies the XML file that form data will be imported from. |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Check whether to construct appearance when loading form controls.
|
inline |
Remove a form control. (Not support to remove a form control from a signature field)
If the specified form control is the only form control of related form field, the related form field will be removed as well.
control | A form control to be removed. If the field type of related form field is e_TypeSignature this function will throw exception e_ErrUnsupported. |
|
inline |
Remove a form field. (Not support signature field)
If the form field appears on more than one PDF page, all representations will be removed.
If user wants to remove a signature field, please use function pdf::PDFDoc::RemoveSignature instead of current function.
field | A form field to be removed. If the field type is e_TypeSignature this function will throw exception e_ErrUnsupported. |
|
inline |
Rename a field with a new name.
field | A valid Field object. |
new_field_name | A new field name. It should not be an empty string. |
|
inline |
Reset data of all fields (except signature fields) to their default value.
|
inline |
Set alignment value which is used as document-wide default value.
Alignment is a property for variable text. It is only applicable 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 value will be used for the text field or list box.
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 a flag that specifies whether to construct appearances when loading form controls.
need_construct | true means to construct appearances when loading form controls, and false means not. |
|
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 an array of form fields in calculation order.
The calculation order defines the order in which the values of fields will be recalculated when value of any field is changed. Usually, these fields have calculation actions.
field_array | An array of form fields to specify the new calculation order. |
|
inline |
Validate whether a field name can be used for a new field in specified field type.
This method can be used to check whether a field name can be used for a new field in specified field type. User is recommended to call this function before using function Form::AddControl to add a new field with a new control.
type | Field type, for which the input field name will be validated. |
field_name | A string value. It should not be an empty string. |