Page functions. More...

Data Structures

struct  A3DPDFFieldData
 A3DPDF3DFieldData structure. More...
 
struct  A3DPDFGraphicArcData
 Structure that defines a graphic circle arc. More...
 
struct  A3DPDFGraphicBezierCurveData
 Structure that defines a graphic bezier curve. More...
 
struct  A3DPDFGraphicCompositePathData
 Structure that defines a graphic path. More...
 
struct  A3DPDFGraphicLineData
 Structure that defines a graphic line. More...
 
struct  A3DPDFGraphicRectangleData
 Structure that defines a graphic rectangle. More...
 
struct  A3DPDFPageData
 A3DPDFPageData structure. More...
 
struct  A3DPDFPageData2
 A3DPDFPageData2 structure. More...
 
struct  A3DPDFRectData
 A3DPDFRectData structure: structure to define a rectangle placement in the PDF page. More...
 
struct  A3DPDFRectDData
 A3DPDFRectDData structure: structure to define a rectangle placement in the PDF page, in double precision. More...
 

Enumerations

enum  A3DPDFEEventActionType {
  kA3DPDFEventPageOpened = 0, kA3DPDFEventPageClosed = 1, kA3DPDFEventPageVisible = 2, kA3DPDFEventPageInvisible = 3,
  kA3DPDFEventFieldEnter = 4, kA3DPDFEventFieldExit = 5, kA3DPDFEventFieldMouseDown = 6, kA3DPDFEventFieldMouseUp = 7,
  kA3DPDFEventFieldFocusIn = 8, kA3DPDFEventFieldFocusOut = 9, kA3DPDFEventDocWillClose = 10, kA3DPDFEventDocWillSave = 11,
  kA3DPDFEventDocDidSave = 12, kA3DPDFEventDocWillPrint = 13, kA3DPDFEventDocDidPrint = 14
}
 Set of events that can trigger the execution of an action. More...
 
enum  A3DPDFEFieldType {
  kA3DPDFText =0, kA3DPDFButton =1, kA3DPDFDropDown, kA3DPDFListBox,
  kA3DPDFCheckBox, kA3DPDFRadioButton, kA3DPDFDigitalSignature, kA3DPDFBarCode
}
 Field type. More...
 
enum  A3DPDFEFormField { kA3DPDFVisible, kA3DPDFHidden, kA3DPDFVisibleNoPrint, kA3DPDFHiddenPrintable }
 Button flags. More...
 
enum  A3DPDFEGraphicType { kA3DPDFGraphicLine = 0, kA3DPDFGraphicArc, kA3DPDFGraphicBezierCurve }
 Graphic types. More...
 
enum  A3DPDFELayoutTextIcon
 Position of the label of the button relative to its icon. More...
 
enum  A3DPDFELineStyleBorder
 Line style of the border of the button. More...
 
enum  A3DPDFEPageOrientation { kA3DPDFPagePortrait = 0, kA3DPDFPageLandscape }
 Page orientation of the PDF document. More...
 
enum  A3DPDFEPageSize {
  kA3DPDFPage11x17 =0, kA3DPDFPageA3, kA3DPDFPageA4, kA3DPDFPageA5,
  kA3DPDFPageB4JIS, kA3DPDFPageB5JIS, kA3DPDFPageExecutive, kA3DPDFPageLegal,
  kA3DPDFPageLetter, kA3DPDFPageTabloid, kA3DPDFPageB4ISO, kA3DPDFPageB5ISO,
  kA3DPDFPageCustom
}
 Page size of the PDF document. More...
 
enum  A3DPDFETextAlignment { kA3DPDFLeft, kA3DPDFCentered, kA3DPDFRight }
 Alignment of the text. More...
 
enum  A3DPDFETextOrientation { kA3DPDFNormal, kA3DPDF90, kA3DPDF180, kA3DPDF270 }
 Orientation of the text. More...
 
enum  A3DPDFEThicknessBorder { kA3DPDFThin, kA3DPDFMedium, kA3DPDFThick }
 Thickness of the border of the button. More...
 

Functions

A3DStatus A3DPDF3DAnnotSetActionJavascript (A3DPDFPage *pPage, A3DPDF3DAnnot *p3DAnnot, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString)
 Function to define a javaScript action to an event triggered on an annotation. The JavaScript is defined as a string. More...
 
A3DStatus A3DPDFButtonCreate (A3DPDFDocument *pDoc, const A3DPDFButtonData *pButtonData, A3DPDFButton **ppButton)
 Function to create a button. More...
 
A3DStatus A3DPDFCheckBoxCreate (A3DPDFDocument *pDoc, const A3DPDFCheckBoxData *pCheckBoxData, A3DPDFCheckBox **ppCheckBox)
 Function to create a CheckBox. More...
 
A3DStatus A3DPDFDigitalSignatureCreate (A3DPDFDocument *pDoc, const A3DPDFDigitalSignatureData *pDigitalSignatureData, A3DPDFDigitalSignature **ppDigitalSignature)
 Function to create a DigitalSignature. More...
 
A3DStatus A3DPDFDocumentSetActionJavascript (A3DPDFDocument *pDoc, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString)
 Function to define a javaScript action to an event triggered on the document. The JavaScript is defined as a string. More...
 
A3DStatus A3DPDFDropDownListCreate (A3DPDFDocument *pDoc, const A3DPDFDropDownListData *pDropDownListData, A3DPDFDropDownList **ppDropDownList)
 Function to create a DropDownList (combo box) More...
 
A3DStatus A3DPDFFieldGetInformation (A3DPDFField *pField, A3DPDFFieldData *pFieldData)
 Function to retrieve useful information regarding a field of a document. More...
 
A3DStatus A3DPDFListBoxCreate (A3DPDFDocument *pDoc, const A3DPDFListBoxData *pListBoxData, A3DPDFListBox **ppListBox)
 Function to create a ListBox. More...
 
A3DStatus A3DPDFPageDrawArc (A3DPDFPage *pPage, const A3DPDFGraphicArcData *pGraphicArcData)
 Function to create a graphic circle arc. More...
 
A3DStatus A3DPDFPageDrawBezierCurve (A3DPDFPage *pPage, const A3DPDFGraphicBezierCurveData *pGraphicBezierCurveData)
 Function to create a graphic bezier curve. More...
 
A3DStatus A3DPDFPageDrawCompositePath (A3DPDFPage *pPage, A3DPDFGraphicCompositePathData *pGraphicPathData)
 Function to create a graphic composite path. More...
 
A3DStatus A3DPDFPageDrawLine (A3DPDFPage *pPage, const A3DPDFGraphicLineData *pGraphicLineData)
 Function to create a graphic line. More...
 
A3DStatus A3DPDFPageDrawRectangle (A3DPDFPage *pPage, const A3DPDFGraphicRectangleData *pGraphicRectangleData)
 Function to create a graphic line. More...
 
A3DStatus A3DPDFPageFieldButtonSetIcon (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDFImage *pImage)
 Function to set the icon of a button form field. More...
 
A3DStatus A3DPDFPageFieldButtonSetLabel (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue)
 Function to set the label of a button form field. 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 A3DPDFPageFieldSet3DAnnot (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDF3DAnnot *p3DAnnot)
 Function to replace the form field specified with a 3D Annot object. More...
 
A3DStatus A3DPDFPageFieldSetActionJavascript (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString)
 Function to attach JavaScript to a form field. The JavaScript is defined as a string. More...
 
A3DStatus A3DPDFPageFieldSetActionJavascriptFromFile (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcFileName)
 This method was deprecated in HOOPS Publish 1.1. Use A3DPDFPageFieldSetActionJavascriptFromString instead. More...
 
A3DStatus A3DPDFPageFieldSetActionJavascriptFromString (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcJavascriptString)
 Function to attach JavaScript to a form field. The JavaScript is defined as a string. More...
 
A3DStatus A3DPDFPageFieldSetVisibility (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DBool bIsVisible)
 Function to set the visibility of a form field. More...
 
A3DStatus A3DPDFPageFieldTextSetValue (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue)
 Function to set the text of a text form field. 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 A3DPDFPageInsert3DAnnot (A3DPDFPage *pPage, const A3DPDF3DAnnot *p3DAnnot, const A3DPDFRectData *pRectData)
 Function to insert a 3D Annot in a page. More...
 
A3DStatus A3DPDFPageInsertButton (A3DPDFPage *pPage, A3DPDFButton *pButton, const A3DPDFRectData *pRectData)
 Function to insert a button in a page. More...
 
A3DStatus A3DPDFPageInsertButtonInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFButton *pButton, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a button in a table. More...
 
A3DStatus A3DPDFPageInsertCheckBox (A3DPDFPage *pPage, A3DPDFCheckBox *pCheckBox, const A3DPDFRectData *pRectData)
 Function to insert a CheckBox in a page. More...
 
A3DStatus A3DPDFPageInsertDigitalSignature (A3DPDFPage *pPage, A3DPDFDigitalSignature *pDigitalSignature, const A3DPDFRectData *pRectData)
 Function to insert a DigitalSignature in a page. More...
 
A3DStatus A3DPDFPageInsertDropDownList (A3DPDFPage *pPage, A3DPDFDropDownList *pDropDownList, const A3DPDFRectData *pRectData)
 Function to insert a DropDownList (combo box) in a page. More...
 
A3DStatus A3DPDFPageInsertImage (A3DPDFPage *pPage, A3DPDFImage *pImage, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom)
 Function to insert an image in a page. More...
 
A3DStatus A3DPDFPageInsertLink (A3DPDFPage *pPage, A3DPDFLink *pLink, const A3DPDFRectData *pRectData)
 Function to insert a link in a page. More...
 
A3DStatus A3DPDFPageInsertLinkInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFLink *pLink, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a link in a table. More...
 
A3DStatus A3DPDFPageInsertListBox (A3DPDFPage *pPage, A3DPDFListBox *pListBox, const A3DPDFRectData *pRectData)
 Function to insert a ListBox in a page. More...
 
A3DStatus A3DPDFPageInsertRadioButton (A3DPDFPage *pPage, A3DPDFRadioButton *pRadioButton, const A3DPDFRectData *pRectData)
 Function to insert a RadioButton in a page. More...
 
A3DStatus A3DPDFPageInsertTable (A3DPDFPage *pPage, A3DPDFTable *pTable, const A3DInt32 iPosLeft, const A3DInt32 iPosTop)
 Function to insert a table in a page. More...
 
A3DStatus A3DPDFPageInsertText (A3DPDFPage *pPage, A3DPDFText *pText, const A3DInt32 iPosLeft, const A3DInt32 iPosBottom)
 Function to insert a text in a page. More...
 
A3DStatus A3DPDFPageInsertTextField (A3DPDFPage *pPage, A3DPDFTextField *pTextField, const A3DPDFRectData *pRectData)
 Function to insert a text field in a page. More...
 
A3DStatus A3DPDFPageInsertTextFieldInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFTextField *pTextField, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a text field in a table. More...
 
A3DStatus A3DPDFPageInsertTextInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFText *pText, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a text in a table. More...
 
A3DStatus A3DPDFPageRemoveTable (A3DPDFPage *pPage, A3DPDFTable *pTable)
 Function to remove a table from a page. More...
 
A3DStatus A3DPDFPageSetActionJavascript (A3DPDFPage *pPage, const A3DPDFEEventActionType eEventActionType, const A3DUTF8Char *pcJavascriptString)
 Function to define a javaScript action to an event triggered on the page. The JavaScript is defined as a string. More...
 
A3DStatus A3DPDFRadioButtonCreate (A3DPDFDocument *pDoc, const A3DPDFRadioButtonData *pRadioButtonData, A3DPDFRadioButton **ppRadioButton)
 Function to create a RadioButton. More...
 
A3DStatus A3DPDFTextFieldCreate (A3DPDFDocument *pDoc, const A3DPDFTextFieldData *pTextFieldData, A3DPDFTextField **ppTextField)
 Function to create a text field. More...
 

Detailed Description

Page functions.

This module describes the functions and structures that allow you to define a PDF Page in the document.

Enumeration Type Documentation

Set of events that can trigger the execution of an action.

The kA3DPDFEventPageOpened and kA3DPDFEventPageClosed event on an annotation object have a similar function in the page object. However, associating these triggers with annotations allows annotation objects to be self-contained. The kA3DPDFEventPageVisible and kA3DPDFEventPageInvisible types allow a distinction between pages that are open and pages that are visible. At any one time, while more than one page may be visible, depending on the page layout.

Version
9.0
Enumerator
kA3DPDFEventPageOpened 

An action that shall be performed when the page, or the page containing the annotation, is opened.

kA3DPDFEventPageClosed 

An action that shall be performed when the page, or the page containing the annotation, is closed.

kA3DPDFEventPageVisible 

An action that shall be performed when the page containing the annotation becomes visible.

kA3DPDFEventPageInvisible 

An action that shall be performed when the page containing the annotation is no longer visible in the conforming reader’s user interface.

kA3DPDFEventFieldEnter 

An action that shall be performed when the cursor enters the annotation’s active area.

kA3DPDFEventFieldExit 

An action that shall be performed when the cursor exits the annotation’s active area.

kA3DPDFEventFieldMouseDown 

An action that shall be performed when the mouse button is pressed inside the annotation’s active area.

kA3DPDFEventFieldMouseUp 

An action that shall be performed when the mouse button is released inside the annotation’s active area.

kA3DPDFEventFieldFocusIn 

An action that shall be performed when the annotation receives the input focus.

kA3DPDFEventFieldFocusOut 

An action that shall be performed when the annotation loses the input focus.

kA3DPDFEventDocWillClose 

An action that shall be performed before closing a document.

kA3DPDFEventDocWillSave 

An action that shall be performed before saving a document.

kA3DPDFEventDocDidSave 

An action that shall be performed after saving a document.

kA3DPDFEventDocWillPrint 

An action that shall be performed before printing a document.

kA3DPDFEventDocDidPrint 

An action that shall be performed after printing a document.

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.

Button flags.

Version
7.2
Enumerator
kA3DPDFVisible 

The button is visible and printable.

kA3DPDFHidden 

The button is hidden and not printable.

kA3DPDFVisibleNoPrint 

The button is visible but not printable.

kA3DPDFHiddenPrintable 

The button is hidden but printable.

Graphic types.

Version
9.1
Enumerator
kA3DPDFGraphicLine 

Graphic line.

kA3DPDFGraphicArc 

Graphic arc.

kA3DPDFGraphicBezierCurve 

Graphic bezier curve.

Position of the label of the button relative to its icon.

Version
7.2

Line style of the border of the button.

Version
7.2

Page orientation of the PDF document.

Version
4.1
Enumerator
kA3DPDFPagePortrait 

Standard portrait orientation.

kA3DPDFPageLandscape 

Standard landscape orientation.

Page size of the PDF document.

Version
4.1
Enumerator
kA3DPDFPage11x17 

Standard 11*17 format. size in points: 792 * 1224.

kA3DPDFPageA3 

Standard A3 format. size in points: 842 * 1190.

kA3DPDFPageA4 

Standard A4 format. size in points: 595 * 842.

kA3DPDFPageA5 

Standard A5 format. size in points: 420 * 595.

kA3DPDFPageB4JIS 

Standard B4 JIS format. size in points: 728 * 1031.

kA3DPDFPageB5JIS 

Standard B5 JIS format. size in points: 515 * 728.

kA3DPDFPageExecutive 

Standard Executive format. size in points: 522 * 756.

kA3DPDFPageLegal 

Standard Legal format. size in points: 612 * 1008.

kA3DPDFPageLetter 

Standard Letter format. size in points: 612 * 792.

kA3DPDFPageTabloid 

Standard Tabloid format. size in points: 792 * 1224.

kA3DPDFPageB4ISO 

Standard B4 ISO format. size in points: 709 * 1001.

kA3DPDFPageB5ISO 

Standard B5 ISO format. size in points: 499 * 709.

kA3DPDFPageCustom 

The page format must be defined using SetPageSize.

Alignment of the text.

Version
7.2
Enumerator
kA3DPDFLeft 

The text is left justified.

kA3DPDFCentered 

The button is centered.

kA3DPDFRight 

The button is right justified.

Orientation of the text.

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.

Thickness of the border of the button.

Version
7.2
Enumerator
kA3DPDFThin 

The border of the button is thin.

kA3DPDFMedium 

The border of the button is medium size.

kA3DPDFThick 

The border of the button is thin.

Function Documentation

A3DStatus A3DPDF3DAnnotSetActionJavascript ( A3DPDFPage pPage,
A3DPDF3DAnnot p3DAnnot,
const A3DPDFEEventActionType  eEventActionType,
const A3DUTF8Char pcJavascriptString 
)

Function to define a javaScript action to an event triggered on an annotation. The JavaScript is defined as a string.

The goal of this function is to define a JavaScript action to be launched on an event triggered on an annotation.

Parameters
[in]pPageThe Page object to work with.
[in]p3DAnnotThe 3D annot object to work with.
[in]eEventActionTypeThe action type.
[in]pcJavascriptStringThe string which contains the JavaScript.
Returns
A3D_SUCCESS
Version
9.0
A3DStatus A3DPDFButtonCreate ( A3DPDFDocument pDoc,
const A3DPDFButtonData pButtonData,
A3DPDFButton **  ppButton 
)

Function to create a button.

The button is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertButton.

Parameters
[in,out]pDocThe Document object to work with.
[in]pButtonDataThe button parameters. The name is mandatory.
[out]ppButtonThe button created.
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFCheckBoxCreate ( A3DPDFDocument pDoc,
const A3DPDFCheckBoxData pCheckBoxData,
A3DPDFCheckBox **  ppCheckBox 
)

Function to create a CheckBox.

The CheckBox is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertCheckBox.

Parameters
[in,out]pDocThe Document object to work with.
[in]pCheckBoxDataThe CheckBox parameters. The name is mandatory.
[out]ppCheckBoxThe CheckBox created.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFDigitalSignatureCreate ( A3DPDFDocument pDoc,
const A3DPDFDigitalSignatureData pDigitalSignatureData,
A3DPDFDigitalSignature **  ppDigitalSignature 
)

Function to create a DigitalSignature.

The DigitalSignature is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertDigitalSignature.

Parameters
[in,out]pDocThe Document object to work with.
[in]pDigitalSignatureDataThe DigitalSignature parameters. The name is mandatory.
[out]ppDigitalSignatureThe DigitalSignature created.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFDocumentSetActionJavascript ( A3DPDFDocument pDoc,
const A3DPDFEEventActionType  eEventActionType,
const A3DUTF8Char pcJavascriptString 
)

Function to define a javaScript action to an event triggered on the document. The JavaScript is defined as a string.

The goal of this function is to define a JavaScript action to be launched on an event triggered on the document level.

Parameters
[in]pDocThe Document object to work with.
[in]eEventActionTypeThe action type. Only kA3DPDFEventDocWillClose, kA3DPDFEventDocWillSave kA3DPDFEventDocDidSave kA3DPDFEventDocWillPrint and kA3DPDFEventDocDidPrint are relevant at document level.
[in]pcJavascriptStringThe string which contains the JavaScript.
Returns
A3D_SUCCESS
Version
9.0
A3DStatus A3DPDFDropDownListCreate ( A3DPDFDocument pDoc,
const A3DPDFDropDownListData pDropDownListData,
A3DPDFDropDownList **  ppDropDownList 
)

Function to create a DropDownList (combo box)

The DropDownList is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertDropDownList. List items can be added using the function A3DPDFPageFieldListAddItem, after the call to A3DPDFPageInsertDropDownList.

Parameters
[in,out]pDocThe Document object to work with.
[in]pDropDownListDataThe DropDownList parameters. The name is mandatory.
[out]ppDropDownListThe DropDownList created.
Returns
A3D_SUCCESS
Version
8.0
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.
[in,out]pFieldDataData structure completed by the function. Contains the attributes of the field.
Version
6.0
A3DStatus A3DPDFListBoxCreate ( A3DPDFDocument pDoc,
const A3DPDFListBoxData pListBoxData,
A3DPDFListBox **  ppListBox 
)

Function to create a ListBox.

The ListBox is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertListBox. List items can be added using the function A3DPDFPageFieldListAddItem, after the call to A3DPDFPageInsertListBox.

Parameters
[in,out]pDocThe Document object to work with.
[in]pListBoxDataThe ListBox parameters. The name is mandatory.
[out]ppListBoxThe ListBox created.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFPageDrawArc ( A3DPDFPage pPage,
const A3DPDFGraphicArcData pGraphicArcData 
)

Function to create a graphic circle arc.

Parameters
[in,out]pPageThe page object to work with.
[in]pGraphicArcDataThe Graphic arc parameters.
Returns
A3D_SUCCESS
Version
9.1
A3DStatus A3DPDFPageDrawBezierCurve ( A3DPDFPage pPage,
const A3DPDFGraphicBezierCurveData pGraphicBezierCurveData 
)

Function to create a graphic bezier curve.

Parameters
[in,out]pPageThe page object to work with.
[in]pGraphicBezierCurveDataThe Graphic Bezier curve parameters.
Returns
A3D_SUCCESS
Version
9.1
A3DStatus A3DPDFPageDrawCompositePath ( A3DPDFPage pPage,
A3DPDFGraphicCompositePathData pGraphicPathData 
)

Function to create a graphic composite path.

Parameters
[in,out]pPageThe page object to work with.
[in]pGraphicPathDataThe parameters of the elements to be drawn.
Returns
A3D_SUCCESS
Version
9.1
A3DStatus A3DPDFPageDrawLine ( A3DPDFPage pPage,
const A3DPDFGraphicLineData pGraphicLineData 
)

Function to create a graphic line.

Parameters
[in,out]pPageThe page object to work with.
[in]pGraphicLineDataThe Graphic line parameters.
Returns
A3D_SUCCESS
Version
9.1
A3DStatus A3DPDFPageDrawRectangle ( A3DPDFPage pPage,
const A3DPDFGraphicRectangleData pGraphicRectangleData 
)

Function to create a graphic line.

Parameters
[in,out]pPageThe Page object to work with.
[in]pGraphicRectangleDataThe Graphic rectangle parameters.
Returns
A3D_SUCCESS
Version
9.1
A3DStatus A3DPDFPageFieldButtonSetIcon ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DPDFImage pImage 
)

Function to set the icon of a button form field.

The image is defined from a A3DPDFImage object. It is always scaled non-proportionally, which means always adapted and stretched to the size of the field. That way, the members m_iWidth and m_iHeight of A3DPDFImageData are not used by this function.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]pImageThe image to store on the button field.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFPageFieldButtonSetLabel ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DUTF8Char pcValue 
)

Function to set the label of a button form field.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the button form field. Only Acroform fields are supported.
[in]pcValueThe label to set to the field.
Returns
A3D_SUCCESS
Version
4.1
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
A3DStatus A3DPDFPageFieldSet3DAnnot ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DPDF3DAnnot p3DAnnot 
)

Function to replace the form field specified with a 3D Annot object.

Note: starting with HOOPS Publish 1.10, several 3D Annots can be stored on a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]p3DAnnotThe 3D Annot to set.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFPageFieldSetActionJavascript ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DPDFEEventActionType  eEventActionType,
const A3DUTF8Char pcJavascriptString 
)

Function to attach JavaScript to a form field. The JavaScript is defined as a string.

The goal of this function is to define a JavaScript action to be launched on an event. The action event is different depending on the type of the field. For fields of type:

  • dropdown list: the action is the selection of a list item.
  • listbox list: the action is the selection of a list item.
  • button: the action is the button pushed.
Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]eEventActionTypeThe action type. Only kA3DPDFEventPageOpened and kA3DPDFEventPageClosed are relevant at page level.
[in]pcJavascriptStringThe string which contains the JavaScript.
Returns
A3D_SUCCESS
Version
9.0
A3DStatus A3DPDFPageFieldSetActionJavascriptFromFile ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DUTF8Char pcFileName 
)

This method was deprecated in HOOPS Publish 1.1. Use A3DPDFPageFieldSetActionJavascriptFromString instead.

Function to attach JavaScript to a form field. The JavaScript is defined in a file.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]pcFileNameThe path of a file containing a JavaScript.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFPageFieldSetActionJavascriptFromString ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DUTF8Char pcJavascriptString 
)

Function to attach JavaScript to a form field. The JavaScript is defined as a string.

The goal of this function is to define a JavaScript action to be launched on an event. The action event is different depending on the type of the field. For fields of type:

  • dropdown list: the action is the selection of a list item.
  • listbox list: the action is the selection of a list item.
  • button: the action is the button pushed.
Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]pcJavascriptStringThe string which contains the JavaScript.
Returns
A3D_SUCCESS
Version
4.1
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
A3DStatus A3DPDFPageFieldTextSetValue ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DUTF8Char pcValue 
)

Function to set the text of a text form field.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]pcValueThe value to set to the text field. Text fields set as multiline can contain carriage return characters, they must be '\r'.
Returns
A3D_SUCCESS
Version
4.1
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 created.
Returns
A3D_SUCCESS
Version
6.0
A3DStatus A3DPDFPageInsert3DAnnot ( A3DPDFPage pPage,
const A3DPDF3DAnnot p3DAnnot,
const A3DPDFRectData pRectData 
)

Function to insert a 3D Annot in a page.

Insert a 3D Annot object on the page. Note: starting with HOOPS Publish 1.10, several 3D Annots can be stored on a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]p3DAnnotThe 3D Annot to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFPageInsertButton ( A3DPDFPage pPage,
A3DPDFButton pButton,
const A3DPDFRectData pRectData 
)

Function to insert a button in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pButtonThe button object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFPageInsertButtonInTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
A3DPDFButton pButton,
A3DInt32  iRowIndex,
A3DInt32  iColumnIndex 
)

Function to insert a button in a table.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert in the table.
[in]pButtonThe Button object to insert in the table.
[in]iRowIndexThe index of the row of the table's cell to insert the button (starts from 1).
[in]iColumnIndexThe index of the column of the table's cell to insert the button (starts from 1).
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFPageInsertCheckBox ( A3DPDFPage pPage,
A3DPDFCheckBox pCheckBox,
const A3DPDFRectData pRectData 
)

Function to insert a CheckBox in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pCheckBoxThe CheckBox object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFPageInsertDigitalSignature ( A3DPDFPage pPage,
A3DPDFDigitalSignature pDigitalSignature,
const A3DPDFRectData pRectData 
)

Function to insert a DigitalSignature in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pDigitalSignatureThe DigitalSignature object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFPageInsertDropDownList ( A3DPDFPage pPage,
A3DPDFDropDownList pDropDownList,
const A3DPDFRectData pRectData 
)

Function to insert a DropDownList (combo box) in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pDropDownListThe DropDownList object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFPageInsertImage ( A3DPDFPage pPage,
A3DPDFImage pImage,
const A3DInt32  iPosLeft,
const A3DInt32  iPosBottom 
)

Function to insert an image in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pImageThe Image object to insert on the page.
[in]iPosLeftThe x coordinate of the insertion point of the image. The insertion point is the bottom left corner of the image. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]iPosBottomThe y coordinate of the insertion point of the image. The insertion point is the bottom left corner of the image. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFPageInsertLink ( A3DPDFPage pPage,
A3DPDFLink pLink,
const A3DPDFRectData pRectData 
)

Function to insert a link in a page.

Parameters
[in]pPageThe Page object to work with.
[in]pLinkThe Link object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
5.2
A3DStatus A3DPDFPageInsertLinkInTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
A3DPDFLink pLink,
A3DInt32  iRowIndex,
A3DInt32  iColumnIndex 
)

Function to insert a link in a table.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert in the table.
[in]pLinkThe Link object to insert in the table.
[in]iRowIndexThe index of the row of the table's cell to insert the link (start from 1)
[in]iColumnIndexThe index of the column of the table's cell to insert the link (start from 1)
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFPageInsertListBox ( A3DPDFPage pPage,
A3DPDFListBox pListBox,
const A3DPDFRectData pRectData 
)

Function to insert a ListBox in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pListBoxThe ListBox object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFPageInsertRadioButton ( A3DPDFPage pPage,
A3DPDFRadioButton pRadioButton,
const A3DPDFRectData pRectData 
)

Function to insert a RadioButton in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pRadioButtonThe RadioButton object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFPageInsertTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
const A3DInt32  iPosLeft,
const A3DInt32  iPosTop 
)

Function to insert a table in a page.

Warning: The positioning is not defined as in the other insertion functions (for texts or images). Here, the position is specified from the top of the page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert on the page.
[in]iPosLeftThe x coordinate of the insertion point of the table. The insertion point is the top left corner of the table. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]iPosTopThe y coordinate of the insertion point of the table. The insertion point is the top left corner of the table. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
Returns
A3D_SUCCESS
Version
5.1
A3DStatus A3DPDFPageInsertText ( A3DPDFPage pPage,
A3DPDFText pText,
const A3DInt32  iPosLeft,
const A3DInt32  iPosBottom 
)

Function to insert a text in a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTextThe Text object to insert on the page.
[in]iPosLeftThe x coordinate of the insertion point of the text. The insertion point is the bottom left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
[in]iPosBottomThe y coordinate of the insertion point of the text. The insertion point is the bottom left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
Returns
A3D_SUCCESS
Version
4.1
A3DStatus A3DPDFPageInsertTextField ( A3DPDFPage pPage,
A3DPDFTextField pTextField,
const A3DPDFRectData pRectData 
)

Function to insert a text field in a page.

The text field must have a name before inserting it.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTextFieldThe Text field object to insert on the page.
[in]pRectDataThe rectangle to specify the position on the page.
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFPageInsertTextFieldInTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
A3DPDFTextField pTextField,
A3DInt32  iRowIndex,
A3DInt32  iColumnIndex 
)

Function to insert a text field in a table.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert in the table.
[in]pTextFieldThe Text field object to insert in the table.
[in]iRowIndexThe index of the row of the table's cell to insert the button (start from 1)
[in]iColumnIndexThe index of the column of the table's cell to insert the button (start from 1)
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFPageInsertTextInTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
A3DPDFText pText,
A3DInt32  iRowIndex,
A3DInt32  iColumnIndex 
)

Function to insert a text in a table.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to insert in the table.
[in]pTextThe Text object to insert in the table.
[in]iRowIndexThe index of the row of the table's cell to insert the button (start from 1)
[in]iColumnIndexThe index of the column of the table's cell to insert the button (start from 1)
Returns
A3D_SUCCESS
Version
7.2
A3DStatus A3DPDFPageRemoveTable ( A3DPDFPage pPage,
A3DPDFTable pTable 
)

Function to remove a table from a page.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTableThe Table object to remove from the page.
Returns
A3D_SUCCESS
Version
8.1
A3DStatus A3DPDFPageSetActionJavascript ( A3DPDFPage pPage,
const A3DPDFEEventActionType  eEventActionType,
const A3DUTF8Char pcJavascriptString 
)

Function to define a javaScript action to an event triggered on the page. The JavaScript is defined as a string.

The goal of this function is to define a JavaScript action to be launched on an event triggered on the page level.

Parameters
[in]pPageThe Page object to work with.
[in]eEventActionTypeThe action type. Only kA3DPDFEventPageOpened and kA3DPDFEventPageClosed are relevant at page level.
[in]pcJavascriptStringThe string which contains the JavaScript.
Returns
A3D_SUCCESS
Version
9.0
A3DStatus A3DPDFRadioButtonCreate ( A3DPDFDocument pDoc,
const A3DPDFRadioButtonData pRadioButtonData,
A3DPDFRadioButton **  ppRadioButton 
)

Function to create a RadioButton.

The RadioButton is primarily created with this function, and it should be positionned on the page with the function A3DPDFPageInsertRadioButton.

Parameters
[in,out]pDocThe Document object to work with.
[in]pRadioButtonDataThe RadioButton parameters. The name is mandatory.
[out]ppRadioButtonThe RadioButton created.
Returns
A3D_SUCCESS
Version
8.0
A3DStatus A3DPDFTextFieldCreate ( A3DPDFDocument pDoc,
const A3DPDFTextFieldData pTextFieldData,
A3DPDFTextField **  ppTextField 
)

Function to create a text field.

The text field is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertTextField.

Parameters
[in,out]pDocThe Document object to work with.
[in]pTextFieldDataThe text field parameters.
[out]ppTextFieldThe text field created.
Returns
A3D_SUCCESS
Version
7.2