Table of Contents
PDF Download
SetaPDF_FormField::getName()
Description
class SetaPDF_FormField {
string getName ( [mixed $oname=false] )
}
This method returns the name of a form field. This is also the index, which is used in the fields-array returned by SetaPDF_FormFiller::getFields(). Furthermore this name can be used to query a form field by SetaPDF_FormFiller::getField().
Parameters
$oname
This parameter is only available as of version 1.2.3.
It has only a meaning if you use form field references in your PDF document. That means, you use a single name for different form fields. If you change one of this fields the value will be updated in each related field.
The API suffixes such form field names with '#N', where N is an incremental number. To get the real name (without '#N') you simply have to pass true to this method.
To get all related fields you can use the 'relatedFields'-property of the SetaPDF_FormFiller instance.
Before version 1.2.3 you can simply check the 'oname'-property.
Return Value
Returns the specific name of a form field. This is the value which was defined in f.g. Acrobat for a form field.
© 2007 - 2012 Setasign · Contact / Imprint