Element Details: PDF+Form+Field
 Back


Available in: Logi Info Source code name: PdfFormField

The PdfFormField element represents one or more fields in the PDF form template with the same name. The value for the Name attribute must exactly match the template field name. Only one PdfFormField element is required for multiple copies of a single field.

Scenario 1 (multiple copies of a field):

The following PDF fields exist:

Date.0, Date.1, Date.2, Date.3

*** Create one PdfFormField element with Name="Date"

Scenario 2 (multiple fields with different names):

The following PDF fields exist:

FirstName, LastName, Title

*** Create three PdfFormField elements with Name="FirstName", "LastName" and "Title"





ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
Flatten
True
False
Setting this attribute to "True" makes this field in the output PDF file Read-Only. This attribute is ignored if the FlattenFields attribute is set to "True". * The default value is "False".
Format
UserDefined
Allows a string to be formatted in various ways, especially for numeric and date values. Specifies formatting characteristics for the data. This attribute has been borrowed from the Microsoft Visual Basic Format function. For more information: http://msdn.microsoft.com/en-us/library/59bz1f0h(VS.71).aspx For dates, the non-specific formats, such as "General Date", "Short Time", etc., are converted according to the browser's international setttings. Also, for very large reports, the non-specific formats perform better. There are also some special formats. "<" and ">" change strings to lower and upper case. "Expanded Spaces" preserves space characters that would otherwise be collapsed by the web browser. "HTML" preserves HTML tags so that they are not encoded - they are embedded rather than shown. "Preserve Line Feeds" preserves line feed and cariage return characters so that the following characters appear on a new line. "mp" formats numbers with the "metric prefix". To format 1,234,567 as "$1.23M", use Format "$#.00mp". Supported metric prefixes are from 1000^6 to 1000^-6 For more information: http://en.wikipedia.org/wiki/Metric_prefix "mpsx" formats the value with x number of significant figures in addition to the metric prefix. So a value of 123456, with format set to mps3 will return 123k. "qq" returns the number of the quarter when the value being formatted represents a date. To return the year and quarter together like "2010 Q1", set the format to "yyyy Qqq". "fyy" and "fyyyy" return the fiscal year. "fqq" returns the fiscal quarter. The fiscal year start date may be configured in the settings' Globalization element. "ww" returns the number of the week. The first day of the week may be configured in the settings' Globalization element.
ID
UserDefined
(Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
Name
UserDefined
(Required) The fieldname (including multiple copies) this PdfFormField element is associated with. If multiple copies of a field exist in the template, simply type the name of the field without the auto-generated numbers. Example: This PdfFormField element will match all "OrderID" fields and the following fields exist in the template: OrderID.0.0, OrderID.1.0, OrderID.2.0 * Type "OrderID" as the value for this attribute.
Value
UserDefined
(Required) A value for the element.



PARENT ELEMENTS

Click element to drill down for more information.

PDF Form


CHILD ELEMENTS

Click element to drill down for more information.



 Back to top