# Indicating when user input falls outside the required format or values in PDF forms

ID: PDF22

Technology: pdf

Type: Technique

## When to Use

Tagged PDF documents

## Description

The objective of this technique is to notify the user when user input to a field that requires a specific, required format (e.g., date fields) is not submitted in that format.

If the required format is not used, an alert dialog describes the nature of the error in text. This may be accomplished through scripting created by the author (see, for example, SCR18: Providing client-side validation and alert). User agents can provide automatic alerts (as described in the examples below).

Once the user dismisses the alert dialog, it may be helpful if the script positions the keyboard focus on the field where the error occurred, although some users may expect the focus to remain on the last control focused prior to the alert appearing. Authors should exercise care to ensure that any movement of the focus will be expected. For example, if the alert announces an error in a phone number format, positioning the focus on the phone number field when the alert is dismissed can be regarded as helpful and expected. In some cases, however, this may not be possible. If multiple input errors occur on the page, an alternative approach to error notification should be implemented.

Ensuring that users are aware an error has occurred, can determine what is wrong, and can correct it are key to software usability and accessibility. Meeting this objective helps ensure that all users can complete for-based transactions with ease and confidence.

### Labels for required formats in form controls

It is also important that users are aware that an error may occur. You can incorporate this information in labels; for example, "Date (MM/DD/YYYY)." See PDF10.

## Examples

### Providing validation for an input field format using Adobe Acrobat Pro

This example is shown with Adobe Acrobat Pro. There are other software tools that perform similar functions.

Many fields, for example: telephone number, postal code, and dates, must have data entered in a specific format or pattern.

1. Access the context menu for the form control that requires a specific format.
2. Select Properties...
3. In the Format tab, select the Format Category (in this case, Date). The Date Options appear.
4. Select the format for this form control (in this case, mm/dd/yyyy).
5. In the General tab, specify "Date (mm/dd/yyyy)" for the Name and Tooltip for the control.

When a user types a recognized date format, it is converted automatically to the specified format. If the date format or value is not recognized, an error alert appears and provides further information

This example is shown in operation in the working example of Required Fields in Acrobat (PDF).

### Validating a required date format in a PDF form using JavaScript using Adobe Acrobat Pro

This example is shown with Adobe Acrobat Pro. There are other software tools that perform similar functions.

The following JavaScript illustrates the use of a script to validate form fields, in this case, a date field. To add this script to the form field, open the Text Field Properties dialog and select Edit in the Validate tab.

    // JavaScript code for date mask format MM/DD/YYYY
    var re = /^[mdy0-9]{2}\/[mdy0-9]{2}\/[mdy0-9]{4}$/
    //Allow blank space in field
    if (event.value !="") {
      if (re.test(event.value) == false) {
        app.alert ({
           cTitle: "Incorrect Format",
           cMsg: "Please enter date using\nmm/dd/yyyy format"
        });
      }
    }

## Tests

### Procedure

For each form field that requires specific input, verify that validation information and instructions are provided by applying the following:

1. Check that the format or value that is required is indicated in the form control's label.
2. Use an erroneous format or value and move off the field: make sure that an alert describing the error is provided.

### Expected Results

- #1 and #2 are true.

## Related Techniques

- G89
- SCR18
- PDF23
- PDF10
- PDF5

## Resources

- Acrobat SDK 2021