Interactive Layout Entities Module

Types

A3DPDFFieldData
A3DPDFEFieldType
A3DPDFEFormField
A3DPDFETextOrientation
A3DPDFEThicknessBorder
A3DPDFELineStyleBorder

Fields

kA3DPDFText
kA3DPDFButton
kA3DPDFDropDown
kA3DPDFListBox
kA3DPDFCheckBox
kA3DPDFRadioButton
kA3DPDFDigitalSignature
kA3DPDFBarCode
kA3DPDFVisible
kA3DPDFHidden
kA3DPDFVisibleNoPrint
kA3DPDFHiddenPrintable
kA3DPDFNormal
kA3DPDF90
kA3DPDF180
kA3DPDF270
kA3DPDFThin
kA3DPDFMedium
kA3DPDFThick
kA3DPDFSolid
kA3DPDFDashed
kA3DPDFBeveled
kA3DPDFInset
kA3DPDFUnderlined

Functions

A3DStatus A3DPDFPageFieldListAddItem()
A3DStatus A3DPDFPageGetFields()
A3DStatus A3DPDFPageGetField()
A3DStatus A3DPDFFieldGetInformation()
A3DStatus A3DPDFWidgetGetPosition()
A3DStatus A3DPDFWidgetGetName()
A3DStatus A3DPDFPageFieldSetVisibility()

Detailed Description

group a3d_pdf_widget_module

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.

Type Documentation

enum A3DPDFEFieldType

Field type.

Version
6.0

Values:

enumerator kA3DPDFText

Field of type ‘Text field’.

enumerator kA3DPDFButton

Field of type ‘Button’.

enumerator kA3DPDFDropDown

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

enumerator kA3DPDFListBox

Field of type ‘List Box’.

enumerator kA3DPDFCheckBox

Field of type ‘Check Box’.

enumerator kA3DPDFRadioButton

Field of type ‘Radio Button’.

enumerator kA3DPDFDigitalSignature

Field of type ‘Digital Signature’.

enumerator kA3DPDFBarCode

Field of type ‘Barcode’. Not used by Publish.

enum A3DPDFEFormField

Field flags.

Version
7.2

Values:

enumerator kA3DPDFVisible

The field is visible and printable.

enumerator kA3DPDFHidden

The field is hidden and not printable.

enumerator kA3DPDFVisibleNoPrint

The field is visible but not printable.

enumerator kA3DPDFHiddenPrintable

The field is hidden but printable.

enum A3DPDFETextOrientation

Orientation of the text in a field.

Version
7.2

Values:

enumerator kA3DPDFNormal

The text has a standard orientation.

enumerator kA3DPDF90

The button is turned 90 from counter clockwise.

enumerator kA3DPDF180

The button is turned 180 from counter clockwise.

enumerator kA3DPDF270

The button is turned 270 from counter clockwise.

enum A3DPDFEThicknessBorder

Thickness of the border of a field.

Version
7.2

Values:

enumerator kA3DPDFThin

The border of the field is thin.

enumerator kA3DPDFMedium

The border of the field is medium size.

enumerator kA3DPDFThick

The border of the field is thin.

enum A3DPDFELineStyleBorder

Line style of the border of a field.

Version
7.2

Values:

enumerator kA3DPDFSolid

Solid line.

enumerator kA3DPDFDashed

Dashed line.

enumerator kA3DPDFBeveled

Beveled line.

enumerator kA3DPDFInset

Inset line.

enumerator kA3DPDFUnderlined

Underlined.

Function Documentation