Module for interactive widgets on a PDF page. More...
Modules | |
Button Module | |
Module to access and define Button field. | |
Text Field Module | |
Module to access and define Text field. | |
Digital Signature Module | |
Module to access and define Digital Signature field. | |
Check Box Module | |
(HOOPS Publish Advanced) Module to access and define Check Box field | |
Radio Button Module | |
(HOOPS Publish Advanced) Module to access and define Radio Button field | |
ListBox Module | |
(HOOPS Publish Advanced) Module to access and define ListBox field | |
Drop down List Module | |
(HOOPS Publish Advanced) Module to access and define Drop down List field | |
View Carousel Module | |
(HOOPS Publish Advanced) Module to access and define View Carousel widget | |
Scroll Table Module | |
(HOOPS Publish Advanced) Module to access and define Scroll Table widget | |
Data Structures | |
struct | A3DPDFFieldData |
A3DPDFFieldData structure. More... | |
Enumerations | |
enum | A3DPDFEFieldType { kA3DPDFText = 0, kA3DPDFButton = 1, kA3DPDFDropDown, kA3DPDFListBox, kA3DPDFCheckBox, kA3DPDFRadioButton, kA3DPDFDigitalSignature, kA3DPDFBarCode } |
Field type. More... | |
enum | A3DPDFEFormField { kA3DPDFVisible, kA3DPDFHidden, kA3DPDFVisibleNoPrint, kA3DPDFHiddenPrintable } |
Field flags. More... | |
enum | A3DPDFELineStyleBorder { kA3DPDFSolid, kA3DPDFDashed, kA3DPDFBeveled, kA3DPDFInset, kA3DPDFUnderlined } |
Line style of the border of a field. More... | |
enum | A3DPDFETextOrientation { kA3DPDFNormal, kA3DPDF90, kA3DPDF180, kA3DPDF270 } |
Orientation of the text in a field. More... | |
enum | A3DPDFEThicknessBorder { kA3DPDFThin, kA3DPDFMedium, kA3DPDFThick } |
Thickness of the border of a field. More... | |
Functions | |
A3DStatus | A3DPDFFieldGetInformation (A3DPDFField *pField, A3DPDFFieldData *pFieldData) |
Function to retrieve useful information regarding a field of a document. More... | |
A3DStatus | A3DPDFPageFieldListAddItem (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcItemValue, const A3DUTF8Char *pcItemExportValue) |
Function to add an item to a form field of type list. More... | |
A3DStatus | A3DPDFPageFieldSetVisibility (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DBool bIsVisible) |
Function to set the visibility of a form field. More... | |
A3DStatus | A3DPDFPageGetField (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, A3DPDFField **ppField) |
Function to get a PDF Field from an existing form field on a page. More... | |
A3DStatus | A3DPDFPageGetFields (A3DPDFPage *pPage, A3DInt32 *piNbFields, A3DPDFField ***pppFields) |
Function to retrieve the fields of a PDF page. The fields supported are only form fields created with Acrobat. LiveCycle Designer fields (XFA) are not supported. More... | |
A3DStatus | A3DPDFWidgetGetName (A3DPDFWidget *pWidget, A3DUTF8Char **ppcWidgetId) |
Function to retrieve the name (identifier) of a widget. More... | |
A3DStatus | A3DPDFWidgetGetPosition (A3DPDFWidget *pWidget, A3DPDFRectDData *pRect) |
Function to retrieve the position of a widget on a page. More... | |
Detailed Description
Module for interactive widgets on a PDF page.
This module describes the functions and structures that allow you to define or retrieve widgets on a PDF Page. Widgets are interactive entitities that can be modified with JavaScript coding at runtime. Functions exist to create widgets on a page, or retrieve widgets on an existing page.
Widgets are divided in two categories: the Fields, and the High Level widgets. Fields are Acrobat Forms entities existing on a page. These Fields can be authored using Acrobat. High Level widgets are HOOPS Publish entities. They usually are built from a set of Fields. High Level widgets can only be authored by HOOPS Publish functions.
Enumeration Type Documentation
◆ A3DPDFEFieldType
enum A3DPDFEFieldType |
Field type.
- Version
- 6.0
◆ A3DPDFEFormField
enum A3DPDFEFormField |
◆ A3DPDFETextOrientation
◆ A3DPDFEThicknessBorder
◆ A3DPDFELineStyleBorder
Function Documentation
◆ A3DPDFPageGetFields()
A3DStatus A3DPDFPageGetFields | ( | A3DPDFPage * | pPage, |
A3DInt32 * | piNbFields, | ||
A3DPDFField *** | pppFields | ||
) |
Function to retrieve the fields of a PDF page. The fields supported are only form fields created with Acrobat. LiveCycle Designer fields (XFA) are not supported.
- Memory Management
When A3DPDFPageGetFields
returns A3D_SUCCESS
, pppFields
can be freed by calling A3DPDFPageGetFields with pPage set to nullptr
- Parameters
-
[in] pPage The Page object to work with. [out] piNbFields The number of fields. [out] pppFields The array of pointer on fields objects.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_SUCCESS
- Version
- 6.0
◆ A3DPDFPageGetField()
A3DStatus A3DPDFPageGetField | ( | A3DPDFPage * | pPage, |
const A3DUTF8Char * | pcFieldName, | ||
A3DPDFField ** | ppField | ||
) |
Function to get a PDF Field from an existing form field on a page.
- Parameters
-
[in] pPage The Page object on which is the field. [in] pcFieldName Unique name for existing field. [out] ppField The Field object.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_SUCCESS
- Version
- 10.0
◆ A3DPDFFieldGetInformation()
A3DStatus A3DPDFFieldGetInformation | ( | A3DPDFField * | pField, |
A3DPDFFieldData * | pFieldData | ||
) |
Function to retrieve useful information regarding a field of a document.
- Parameters
-
[in] pField The Field object to work with. [out] pFieldData Data structure completed by the function. Contains the attributes of the field.
- Version
- 6.0
◆ A3DPDFWidgetGetPosition()
A3DStatus A3DPDFWidgetGetPosition | ( | A3DPDFWidget * | pWidget, |
A3DPDFRectDData * | pRect | ||
) |
Function to retrieve the position of a widget on a page.
Widgets are fields or more high-level entities.
- Parameters
-
[in] pWidget The Widget object to work with. [out] pRect Data structure completed by the function. Contains the position of the widget.
- Version
- 10.0
◆ A3DPDFWidgetGetName()
A3DStatus A3DPDFWidgetGetName | ( | A3DPDFWidget * | pWidget, |
A3DUTF8Char ** | ppcWidgetId | ||
) |
Function to retrieve the name (identifier) of a widget.
Widgets are fields or more high-level entities.
- Memory Management
When A3DPDFWidgetGetName
returns A3D_SUCCESS
, ppcWidgetId
can be freed by calling A3DPDFWidgetGetName with pWidget set to nullptr
- Parameters
-
[in] pWidget The Widget object to work with. [out] ppcWidgetId The identifier as a string.
- Version
- 10.0
◆ A3DPDFPageFieldSetVisibility()
A3DStatus A3DPDFPageFieldSetVisibility | ( | A3DPDFPage * | pPage, |
const A3DUTF8Char * | pcFieldName, | ||
const A3DBool | bIsVisible | ||
) |
Function to set the visibility of a form field.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] bIsVisible Specifies if the field should be visible or not.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_SUCCESS
- Version
- 4.1
◆ A3DPDFPageFieldListAddItem()
A3DStatus A3DPDFPageFieldListAddItem | ( | A3DPDFPage * | pPage, |
const A3DUTF8Char * | pcFieldName, | ||
const A3DUTF8Char * | pcItemValue, | ||
const A3DUTF8Char * | pcItemExportValue | ||
) |
Function to add an item to a form field of type list.
- Parameters
-
[in,out] pPage The Page object to work with. [in] pcFieldName The name of the form field. Only Acroform fields are supported. [in] pcItemValue The item string which will be visible to the user in the list field. [in] pcItemExportValue The export value for the item. This value acts as a 'symbolic value' for the item.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_SUCCESS
- Version
- 4.3