(HOOPS Publish Advanced) Module to access and define ListBox field More...

Data Structures

struct  A3DPDFListBoxData
 Structure to define a list box field. More...
 

Functions

A3DStatus A3DPDFListBoxCreate (A3DPDFDocument *pDoc, const A3DPDFListBoxData *pListBoxData, A3DPDFListBox **ppListBox)
 Function to create a ListBox. More...
 
A3DStatus A3DPDFPageInsertListBox (A3DPDFPage *pPage, A3DPDFListBox *pListBox, const A3DPDFRectData *pRectData)
 Function to insert a ListBox in a page. More...
 

Detailed Description

(HOOPS Publish Advanced) Module to access and define ListBox field

This module describes the functions and structures that allow you to define a ListBox. A ListBox is an Acrobat Field.

Function Documentation

◆ A3DPDFListBoxCreate()

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 positioned 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 in case of success or an error code
Return values
A3D_SUCCESS
Version
8.0

◆ A3DPDFPageInsertListBox()

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 in case of success or an error code
Return values
A3D_SUCCESS
Version
8.0