Text Field Module

Detailed Description

group a3d_pdffield_text

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.

Type Documentation

enum A3DPDFETextAlignment

Alignment of the text.

Version
7.2

Values:

enumerator kA3DPDFLeft

The text is left justified.

enumerator kA3DPDFCentered

The button is centered.

enumerator kA3DPDFRight

The button is right justified.

Function Documentation

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.

Version
7.2

Parameters:
  • pDoc – [inout] The Document object to work with.
  • pTextFieldData – [in] The text field parameters.
  • ppTextField – [out] The text field created.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
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.

Version
7.2

Parameters:
  • pPage – [inout] The Page object to work with.
  • pTextField – [in] The Text field 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
A3DStatus A3DPDFPageInsertTextFieldInTable(A3DPDFPage *pPage, A3DPDFTable *pTable, A3DPDFTextField *pTextField, A3DInt32 iRowIndex, A3DInt32 iColumnIndex)

Function to insert a text field in a table.

See also

Table Module.

Version
7.2

Parameters:
  • pPage – [inout] The Page object to work with.
  • pTable – [in] The Table object to insert in the table.
  • pTextField – [in] The Text field object to insert in the table.
  • iRowIndex – [in] The index of the row of the table’s cell to insert the button (start from 1)
  • iColumnIndex – [in] The index of the column of the table’s cell to insert the button (start from 1)
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFPageFieldTextSetValue(A3DPDFPage *pPage, const A3DUTF8Char *pcFieldName, const A3DUTF8Char *pcValue)

Function to set the text of a text form field.

Version
4.1

Parameters:
  • pPage – [inout] The Page object to work with.
  • pcFieldName – [in] The name of the form field. Only Acroform fields are supported.
  • pcValue – [in] The value to set to the text field. Text fields set as multiline can contain carriage return characters, they must be ‘\r’.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFTextFieldSetValue(A3DPDFTextField *pTextField, const A3DUTF8Char *pcValue)

Function to set the text of a text form field.

Version
10.0

Parameters:
  • pTextField – [inout] The Text field object to work with.
  • pcValue – [in] The value to set to the text field. Text fields set as multiline can contain carriage return characters, they must be ‘\r’.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code