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

Data Structures

struct  A3DPDFTextFieldData
 Structure to define a text field. More...
 

Enumerations

enum  A3DPDFETextAlignment {
  kA3DPDFLeft,
  kA3DPDFCentered,
  kA3DPDFRight
}
 Alignment of the text. More...
 

Functions

A3DStatus A3DPDFPageFieldTextSetValue (A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue)
 Function to set the text of a text form field. More...
 
A3DStatus A3DPDFPageInsertTextField (A3DPDFPage *pPage, A3DPDFTextField *pTextField, const A3DPDFRectData *pRectData)
 Function to insert a text field in a page. More...
 
A3DStatus A3DPDFPageInsertTextFieldInTable (A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFTextField *pTextField, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)
 Function to insert a text field in a table. More...
 
A3DStatus A3DPDFTextFieldCreate (A3DPDFDocument *pDoc, const A3DPDFTextFieldData *pTextFieldData, A3DPDFTextField **ppTextField)
 Function to create a text field. More...
 
A3DStatus A3DPDFTextFieldSetValue (A3DPDFTextField *pTextField, const A3DUTF8Char *pcValue)
 Function to set the text of a text form field. More...
 

Detailed Description

Module to access and define Text field.

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

Enumeration Type Documentation

◆ A3DPDFETextAlignment

Alignment of the text.

Version
7.2
Enumerator
kA3DPDFLeft 

The text is left justified.

kA3DPDFCentered 

The button is centered.

kA3DPDFRight 

The button is right justified.

Function Documentation

◆ A3DPDFTextFieldCreate()

A3DStatus A3DPDFTextFieldCreate ( A3DPDFDocument pDoc,
const A3DPDFTextFieldData pTextFieldData,
A3DPDFTextField **  ppTextField 
)

Function to create a text field.

The text field is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsertTextField.

Parameters
[in,out]pDocThe Document object to work with.
[in]pTextFieldDataThe text field parameters.
[out]ppTextFieldThe text field created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
7.2

◆ A3DPDFPageInsertTextField()

A3DStatus A3DPDFPageInsertTextField ( A3DPDFPage pPage,
A3DPDFTextField pTextField,
const A3DPDFRectData pRectData 
)

Function to insert a text field in a page.

The text field must have a name before inserting it.

Parameters
[in,out]pPageThe Page object to work with.
[in]pTextFieldThe Text field 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

◆ A3DPDFPageInsertTextFieldInTable()

A3DStatus A3DPDFPageInsertTextFieldInTable ( A3DPDFPage pPage,
A3DPDFTable pTable,
A3DPDFTextField pTextField,
A3DInt32  iRowIndex,
A3DInt32  iColumnIndex 
)

Function to insert a text field 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]pTextFieldThe Text field object to insert in the table.
[in]iRowIndexThe index of the row of the table's cell to insert the button (start from 1)
[in]iColumnIndexThe index of the column of the table's cell to insert the button (start from 1)
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
7.2

◆ A3DPDFPageFieldTextSetValue()

A3DStatus A3DPDFPageFieldTextSetValue ( A3DPDFPage pPage,
const A3DUTF8Char pcFieldName,
const A3DUTF8Char pcValue 
)

Function to set the text of a text form field.

Parameters
[in,out]pPageThe Page object to work with.
[in]pcFieldNameThe name of the form field. Only Acroform fields are supported.
[in]pcValueThe value to set to the text field. Text fields set as multiline can contain carriage return characters, they must be '\r'.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
4.1

◆ A3DPDFTextFieldSetValue()

A3DStatus A3DPDFTextFieldSetValue ( A3DPDFTextField pTextField,
const A3DUTF8Char pcValue 
)

Function to set the text of a text form field.

Parameters
[in,out]pTextFieldThe Text field object to work with.
[in]pcValueThe value to set to the text field. Text fields set as multiline can contain carriage return characters, they must be '\r'.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0