|
FoxitPDFSDKforWeb
7.1.1
Foxit PDF SDK for Web
|
Public Member Functions | |
| addControl (pageIndex, fieldName, fieldType, 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... | |
| calculate (field) | |
| Calculate form fields' value. More... | |
| getField (title, wildcast=false) | |
| Get PDFField specified by title(a.k.a name). More... | |
| getFieldByIndex (index) | |
| Get PDFField specified by index. More... | |
| getFieldCount () | |
| Get the count of form fields including unsupported signature. More... | |
| removeField (fieldName) | |
| Remove a form field. (Not support signature field) More... | |
| resetForm (fieldNames=[], flags=0, source) | |
| Reset form fields value to default value. More... | |
PDF Form object
The PDF form module is a tree structure with the PDFForm as the root node, PDFField as the intermediate node and the Widget annotation (which called Form Control) as the leaf node.
|
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)
| pageIndex | {number} - An interge indecate page's index. |
| fieldName | {string} - Field name. |
| fieldType | {number} - Field type. Please refer to Field_Type except #Field_Type.Unknown and #Field_Type.Sign. |
| rect | {PDFRect} - Rectangle of the new form control which specifies the position in PDF page. It should be in [PDF coordinate system]. |
|
inline |
Calculate form fields' value.
| field | {PDFField} - Target field which to be setted. |
|
inline |
|
inline |
|
inline |
Get the count of form fields including unsupported signature.
|
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.
| fieldName | {string} - A string value. It should not be an empty string. |
|
inline |
Reset form fields value to default value.
| fieldNames | {Array[string]} - Specifies target fields, could be empty. |
| flags | {number} - Specifies reseting flags.Please refer to reference 1.7 Table 8.88. |
| source | {PDFField} - Specifies source field which trigger this action. If pass Null to this, calulation will not be performed. |