Scroll Table Module

Detailed Description

group a3d_pdfwidget_scrolltable

(HOOPS Publish Advanced) Module to access and define Scroll Table widget

This module describes the functions and structures that allow you to define a Scroll Table. A Scroll Table is a high level widget.

Type Documentation

enum A3DPDFEColumnType

Type of content of the column.

Version
10.2

Values:

enumerator kA3DPDFTextContent

The contents of the column are texts.

enumerator kA3DPDFImageContent

The contents of the column are pictures.

enumerator kA3DPDFCheckBoxContent

The contents of the column are checkboxes.

Function Documentation

A3DStatus A3DPDFScrollTableCreate(A3DPDFDocument *pDoc, const A3DPDFScrollTableData *pScrollTableData, A3DPDFScrollTable **ppScrollTable)

Function to create a ScrollTable widget.

The ScrollTable is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertScrollTable. Ultimately, the widget should be linked to a data table with A3DPDFScrollTableBindToTable.

Version
10.0

Parameters:
  • pDoc[inout] The Document object to work with.
  • pScrollTableData[in] The ScrollTable parameters. The name is mandatory.
  • ppScrollTable[out] The ScrollTable created.
Return values:

A3D_SUCCESS

Returns:

A3D_SUCCESS in case of success or an error code

A3DStatus A3DPDFPageInsertScrollTable(A3DPDFPage *pPage, A3DPDFScrollTable *pScrollTable, const A3DInt32 iPosLeft, const A3DInt32 iPosTop)

Function to insert a ScrollTable widget in a page.

Version
10.0

Parameters:
  • pPage[inout] The Page object to work with.
  • pScrollTable[in] The ScrollTable object to insert on the page.
  • iPosLeft[in] The x coordinate of the insertion point of the text. The insertion point is the top left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
  • iPosTop[in] The y coordinate of the insertion point of the text. The insertion point is the top left corner of the text. The coordinate origin (0, 0) is the bottom left of the page. The unit is point.
Return values:
  • A3D_SUCCESS
  • A3DPDF_CANNOT_INITIALIZE_RESOURCES – if the resources directory is not properly defined.
Returns:

A3D_SUCCESS in case of success or an error code