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
 
 
 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

Field type.

Version
6.0
Enumerator
kA3DPDFText 

Field of type 'Text field'.

kA3DPDFButton 

Field of type 'Button'.

kA3DPDFDropDown 

Field of type 'Drop-down list' (also named 'Combo box').

kA3DPDFListBox 

Field of type 'List Box'.

kA3DPDFCheckBox 

Field of type 'Check Box'.

kA3DPDFRadioButton 

Field of type 'Radio Button'.

kA3DPDFDigitalSignature 

Field of type 'Digital Signature'.

kA3DPDFBarCode 

Field of type 'Barcode'. Not used by Publish.

◆ A3DPDFEFormField

Field flags.

Version
7.2
Enumerator
kA3DPDFVisible 

The field is visible and printable.

kA3DPDFHidden 

The field is hidden and not printable.

kA3DPDFVisibleNoPrint 

The field is visible but not printable.

kA3DPDFHiddenPrintable 

The field is hidden but printable.

◆ A3DPDFETextOrientation

Orientation of the text in a field.

Version
7.2
Enumerator
kA3DPDFNormal 

The text has a standard orientation.

kA3DPDF90 

The button is turned 90° from counter clockwise.

kA3DPDF180 

The button is turned 180° from counter clockwise.

kA3DPDF270 

The button is turned 270° from counter clockwise.

◆ A3DPDFEThicknessBorder

Thickness of the border of a field.

Version
7.2
Enumerator
kA3DPDFThin 

The border of the field is thin.

kA3DPDFMedium 

The border of the field is medium size.

kA3DPDFThick 

The border of the field is thin.

◆ A3DPDFELineStyleBorder

Line style of the border of a field.

Version
7.2
Enumerator
kA3DPDFSolid 

Solid line.

kA3DPDFDashed 

Dashed line.

kA3DPDFBeveled 

Beveled line.

kA3DPDFInset 

Inset line.

kA3DPDFUnderlined 

Underlined.

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.

Parameters
[in]pPageThe Page object to work with.
[out]piNbFieldsThe number of fields.
[out]pppFieldsThe array of pointer on fields objects.
Returns
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]pPageThe Page object on which is the field.
[in]pcFieldNameUnique name for existing field.
[out]ppFieldThe Field object.
Returns
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]pFieldThe Field object to work with.
[out]pFieldDataData 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]pWidgetThe Widget object to work with.
[out]pRectData 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.

Parameters
[in]pWidgetThe Widget object to work with.
[out]ppcWidgetIdThe 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]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]bIsVisibleSpecifies if the field should be visible or not.
Returns
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]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]pcItemValueThe item string which will be visible to the user in the list field.
[in]pcItemExportValueThe export value for the item. This value acts as a 'symbolic value' for the item.
Returns
A3D_SUCCESS
Version
4.3