Module to access and define Button field. More...

Data Structures

struct  A3DPDFButtonData
 Structure to define a button field. More...
 

Enumerations

enum  A3DPDFELayoutTextIcon {
  kA3DPDFLabelOnly,
  kA3DPDFIconOnly,
  kA3DPDFIconTopLabelBottom,
  kA3DPDFLabelTopIconBottom,
  kA3DPDFIconLeftLabelRight,
  kA3DPDFLabelLeftIconRight,
  kA3DPDFLabelOverIcon
}
 Position of the label of the button relative to its icon. More...
 

Functions

A3DStatus A3DPDFButtonCreate (A3DPDFDocument *pDoc, const A3DPDFButtonData *pButtonData, A3DPDFButton **ppButton)
 Function to create a button. More...
 
A3DStatus A3DPDFButtonSetIcon (A3DPDFButton *pButton, const A3DPDFImage *pImage)
 Function to set the icon of a button form field. More...
 
A3DStatus A3DPDFButtonSetLabel (A3DPDFButton *pButton, const A3DUTF8Char *pcLabel)
 Function to set the label of a button form field. 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 *pcLabel)
 Function to set the label of a button form field. 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...
 

Detailed Description

Module to access and define Button field.

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

Enumeration Type Documentation

◆ A3DPDFELayoutTextIcon

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

Version
7.2
Enumerator
kA3DPDFLabelOnly 

Only the label will be displayed.

kA3DPDFIconOnly 

Only the icon will be displayed.

kA3DPDFIconTopLabelBottom 

The label will be displayed below the icon.

kA3DPDFLabelTopIconBottom 

The label will be displayed above the icon.

kA3DPDFIconLeftLabelRight 

The label will be displayed to the right of the icon.

kA3DPDFLabelLeftIconRight 

The label will be displayed to the left of the icon.

kA3DPDFLabelOverIcon 

The label will be displayed on top of the icon.

Function Documentation

◆ A3DPDFButtonCreate()

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

◆ A3DPDFPageInsertButton()

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

◆ A3DPDFPageInsertButtonInTable()

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.
See also
Table Module.
Parameters
[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 in case of success or an error code
Return values
A3D_SUCCESS
Version
7.2

◆ A3DPDFPageFieldButtonSetLabel()

A3DStatus A3DPDFPageFieldButtonSetLabel ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DUTF8Char pcLabel 
)

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]pcLabelThe label to set to the field.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
4.1

◆ A3DPDFButtonSetLabel()

A3DStatus A3DPDFButtonSetLabel ( A3DPDFButton pButton,
const A3DUTF8Char pcLabel 
)

Function to set the label of a button form field.

Parameters
[in,out]pButtonThe Button object to work with.
[in]pcLabelThe label to set to the field.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0

◆ A3DPDFPageFieldButtonSetIcon()

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

◆ A3DPDFButtonSetIcon()

A3DStatus A3DPDFButtonSetIcon ( A3DPDFButton pButton,
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]pButtonThe Button object to work with.
[in]pImageThe image to store on the button field.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0