ColdFusion 9.0 Resources

cfpdfformparam

Description

Provides additional information to the cfpdfform tag.

The cfpdfformparam tag is always a child tag of the cfpdfform or cfpdfsubform tag. Use the cfpdfformparam tag to populate fields in a PDF form.

History

ColdFusion 8: Added this tag.

Syntax

<cfpdfform ...> 
    <cfpdfformparam 
    name = "field name" 
    value = "ColdFusion variable" 
    index = "integer"> 
</cfpdfform>

Note: You can specify this tag’s attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag’s attribute names as structure keys.

Attributes

Attribute	Req/Opt	Default	Description
`index`	Optional	1	Index associated with the field name. If multiple fields have the same name, use the index value to locate one of them. Applies to forms created in LiveCycle only.
`name`	Required		Field name on the PDF form.
`value`	Required		Value associated with the field name. For interactive fields, specify a ColdFusion variable.

Usage

Use the cfpdfformparam tag inside the cfpdfform tag or the cfpdfsubform tag to populate fields in a PDF form.

Use the index attribute of the cfpdfformparam tag to specify fields with the same name and different values, as the following code shows:

<!--- This example shows how to use multiple cfpdfformparam tags with the same name and 
    different index values for a PDF form that contains fields with same name. ---> 
<cfpdfform source="c:\payslipTemplate.pdf" 
    destination="c:\employeeid123.pdf" action="populate"> 
        <cfpdfformparam name="phone" value="781-869-1234" index="1"/> 
        <cfpdfformparam name="phone" value="617-273-9021" index="2"/> 
</cfpdfform>

Note: Use the index attribute with forms created in LiveCycle only. Forms created in Acrobat cannot contain more than one field with the same name; therefore the index attribute is not valid.

Example

See the cfpdfform tag examples.