ListBox Module

Types

A3DPDFListBoxData

Functions

A3DStatus

A3DPDFListBoxCreate

A3DStatus

A3DPDFPageInsertListBox

Detailed Description

group a3d_pdffield_listbox

(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

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.

Version

8.0

Parameters
  • pDoc[inout] The Document object to work with.

  • pListBoxData[in] The ListBox parameters. The name is mandatory.

  • ppListBox[out] The ListBox created.

Return values

A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPDFPageInsertListBox(A3DPDFPage *pPage, A3DPDFListBox *pListBox, const A3DPDFRectData *pRectData)

Function to insert a ListBox in a page.

Version

8.0

Parameters
  • pPage[inout] The Page object to work with.

  • pListBox[in] The ListBox object to insert on the page.

  • pRectData[in] The rectangle to specify the position on the page.

Return values

A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code