![date.field.properties.pane](date.field.properties.pane.png)
Figure 5. Date Field Tool, Text Field Properties Pane
The Text Field Properties pane can be used to determine a range of style and functionality options for date fields. For example, it is possible to use the Actions properties to add multiple dynamic actions to date fields, such as running JavaScript, launching web links and opening files on the local computer. (JavaScript is a high-level programming language that can be used to perform custom operations. See here for an index of existing JavaScript operations that the PDF-XChange Editor forms can use, as well as additional information about JavaScript).
The options detailed below are available in the Date Field Properties pane:
The General properties determine the general parameters of date fields:
•Read Only determines whether or not the date field can be edited. •Locked determines whether or not the date field can be moved, and whether or not its properties can be modified. •Field Name determines the name of the date field. This name is present when the Select Fields tool is enabled, and when date fields are listed in the Fields pane. •Tooltip determines the information displayed when the pointer is hovered over the date field. •Mapping Name determines the mapping name that the date field uses. This name is used to reference interactive form data when the form is exported, and does so without affecting the appearance of the name in the original document. •Orientation determines the orientation of text entered in the date field. •Visibility determines the visibility of the date field. •Required determines whether or not the date field is a required field. Required fields must be filled before documents that contain them can be submitted. •Exportable determines whether or not the date field data can be exported from the form.
The Style properties determine stylistic elements of date fields. They are detailed beneath (figure 4).
The Position properties determine the position and dimensions of date fields:
•Left determines the distance of the date field from the left margin. •Top determines the distance of the date field from the bottom of the page. •Width/Height determine the width/height of the date field.
The Default Text Format properties determine the default properties when text is entered into the date field:
•Font determines the font used. •Font Size determines the size of the font. •Text Color determines the color of the font.
The Options properties determine additional options for date fields:
•Alignment determines the text alignment within the date field. •Default Value determines the default value of the date field. Date fields will show this value by default. If they are edited and then reset then the value entered for this property will be displayed. •File Select determines whether or not files on the local computer are selected when their filename is entered in the date field. If set to Yes then the file contents are submitted as the value of the date field when the form is submitted. •The Password property is not applicable to date fields. •The Check Spelling property is not applicable to date fields. •The Multi Line property is not applicable to date fields. •The Scroll property is not applicable to date fields. •Allow Rich Text determines whether or not the date field permits rich text such as bold and italics. •The Comb property is not applicable to date fields. •Character Limit determines the maximum number of characters permitted in the date field.
The Actions properties determine the action taken when users interact with the date field:
•Mouse Down initiates an action when the left mouse button is pressed (without being released) on the date field. •Mouse Up initiates an action when the left mouse button is clicked (pressed and released) on the date field. •Mouse Enter initiates an action when the pointer moves into the date field. •Mouse Leave initiates an action when the pointer moves out of the date field. •On Focus initiates an action when the date field is selected. •On Blur initiates an action when the date field is deselected. •Click the ellipsis icon on the right of actions to add/edit date field actions:
![text.field.ellipses](text.field.ellipses.png)
Figure 7. Date Field Properties Pane, Action Ellipses
The process of adding actions is detailed here.
The Format Value properties determine the type of information permitted to be entered in the date field and the format in which it should be entered. Date fields are set to Date by default.
•Category determines the category of the field. Each category has different options, as detailed below: •None determines that there is no category for the field. •Number sets the field input to numerical values. The following options are available for this property: •Decimal Places determines the number of decimal places displayed. •Separator Style determines the separators used for numbers. •Currency Symbol determines the currency symbol used in the date field. •Symbol Location determines the location of the currency symbol in relation to the number. •Add Space inserts a space between the currency symbol and the number. •Negative Number Style determines how numbers with negative values are displayed. •Percentage sets the field input to percentage values. The following options are available for this property: •Decimal Places determines the number of decimal places permitted. •Separator Style determines the separator used for numbers. •Date is the default setting and sets the field input to date values, then adds a dropdown calendar to the date field. Use the Date Format parameter to determine the format of dates. •Time sets the field input to time values (hours and minutes). Use the Time Format parameters to determine the format of time values. •Special sets the field input values to one of the special options. Use the Special Format parameter to determine the format. The options are: •ZIP Code •ZIP Code +4, which is used for nine-digit postal codes. •Phone Number •Social Security Number •Custom Action adds custom JavaScript actions to date fields. There are two options: •Format Action is used to enable custom JavaScript for formats. Click the ellipsis icon to add/view JavaScript. •Keystroke Action is used to enable custom JavaScript for keystrokes. Click the ellipsis icon to add/view JavaScript. •If the options above are used then the Edit Action: "Run a JavaScript" dialog box will open. Enter the desired JavaScript for the action and then click OK:
![11.sample.JavaScript](11.sample.javascript.png)
Figure 8. Edit Action: "Run a JavaScript" Dialog Box
The Value Validation properties determine the validation of values entered into the date field. These properties can be used to ensure that the information entered into forms fits within specific parameters:
•Validation determines how values are validated: •Value in Range sets the range within which values entered into the date field must fall: •From specifies the minimum value. •To specifies the maximum value. •Custom Action enables the use of custom JavaScript in order to validate values entered in the date field: •Validation Action specifies the JavaScript to use, as detailed in (figure 9).
The Value Calculation properties determine the value of date fields from other date fields, and are used in forms where entered form data creates the value of further forms, such as when several orders are placed that combine to give a total cost. The available properties are detailed below:
•None specifies that calculations are not performed. •Sum uses the sum of specified fields. •Product uses the product of specified fields. •Average uses the average of specified fields. •Minimum uses the minimum value of all the specified fields. •Maximum uses the maximum value of all specified fields. •Please note that when the Sum, Product, Average, Minimum and Maximum properties are used, the additional entry "Fields" will appear beneath the Calculation property. Use this entry to specify the fields used in these calculations. •Simplified Notation enables the insertion of a custom calculation to be performed on fields. Use the Simple Notation box to determine the calculation. Use the document field names and standard mathematical notation. •Custom Action enables the use of custom JavaScript in order to perform calculations and determine the order in which calculations are performed. Click the ellipsis icon to add custom JavaScript, as detailed in (figure 9).
Examples of Value Validation and Value Calculation are available here.
|