Manuals

 

SetaPDF_TextField::setValue()

Description

class SetaPDF_TextField extends SetaPDF_FormField {
mixed setValue ( mixed $value[, boolean $dontReCreateAppearance=false] ) }

Sets the new value for a form field.

Parameters

$value

The new value of the text field.

Experimental: If the text field is defined as a rich text field and the $renderAppearancesByViewer-parameter of the factory-method is set to true, the method accepts an array with 2 keys:

Key 0:
The value for the style-attribute of the body-tag.

Key 1:
The new content of the body tag.

$dontReCreateAppearance

This flag is experimental and is recognized only if the $renderAppearancesByViewer-parameter of the factory-method is set to true. If this parameter is set to true the API will not create the appearance for the text field (this will be done by the viewer application), which will lead into a faster form filling process.

Return Value

True, if everythings works as expected. A SetaPDF_Error object if an error occurs.