File Preview Control

Preview a file that has been uploaded from a previous Task via a File Upload control in that Request.

Control Description

The File Preview control allows the Request participant to configure a file preview that has been previously uploaded to that Request via a File Upload control. After adding the control in the Screen to where to display the file preview, configure the Name setting value for the File Upload control from which to preview the file it uploaded to that Request.

This control is only available for the following Screen types:

• Display type

• Form type

See Screen Types.

For a documented example of using the File Preview control, see Preview or Download Multiple Files Uploaded from a Previous Task.

Add the Control to a Screen

Permissions

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:

• Screens: Edit Screens

• Screens: View Screens

See the Screens permissions or ask your Administrator for assistance.

Follow these steps to add this control to the Screen:

1. Create a new Form-type or Display-type Screen or edit an existing one.

2. From the Controls Menu on the left, expand the Files category, and then locate the File Preview icon.
3. Drag and drop the control to the Screen Builder canvas. Existing controls in the Screen will adjust positioning based on where you drag the control.
4. Configure the File Preview control. See Settings.

5. Validate that the control is configured correctly. See Validate Your Screen.

When used in a published process, the File Preview control will display the file configured in its settings.

The File Preview controls supports the following file formats:

• Text Documents (TXT, RTF)

• Audio Files (MP3, AAC, M4A, WAV, AIFF, AIF)

• Archive Files (ZIP, TAR, GZ, CAB, BZ2, TAR.GZ, TAR.BZ2)

• Code Files (PHP, JS, JSON, SH, HTML, CSS)

• Spreadsheet Files (XLS, XLSX, ODS)

• Image Files (GIF, JPG, JPEG, PNG, SVG, TIFF, RAW, PSD)

• PDF Documents (PDF, ODF, PS, EPS)

• Presentation Files (PPT, PPTX, ODP)

• Video Files (MP4, MOV, MPEG, WEBM, MPG, MP2, OGG, AVI, WMV, MKV)

• Word Documents (DOC, DOCX, ODT)

Settings

The File Preview control has the following configurable settings in the Properties Panel:

• Variable panel

• Configuration panel

• Advanced panel

Variable Panel Settings

Expand the Variable panel from the Properties Panel on the right to configure the following properties:

Variable Name

Edit the default Variable Name setting value for this control if necessary. The Variable Name setting value represents data in this control during Requests. Ensure that the Variable Name setting value is a unique name from other controls in this Screen and contains at least one letter. This is a required setting.

Use the Variable Name setting value to reference this value in Visibility Rule setting expressions.

See best practices when editing a Request variable name.

Configuration Panel Settings

Expand the Configuration panel from the Properties Panel on the right to configure the following properties:

File Name

Enter the Name setting value for the File Upload control from which to preview its file that was previously uploaded to this Request. Do not use mustache syntax when entering the File Upload control's Name setting. This setting has no default value.

Advanced Panel Settings

Expand the Advanced panel from the Properties Panel on the right to configure the following properties:

Visibility Rule

Specify an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components. If this setting does not have an expression, then this control displays by default.

For example, this control displays if the variable value tip is 1. For a detailed example of the Visibility Rule setting, see Show or Hide Controls Based on Button Selection.

Note the following regarding how to use visibility rules:

• To make this control hidden until another control contains a value, enter the Variable Name setting value of that control to this control's Visibility Rule setting.

• Visibility rules override custom CSS settings.

Device Visibility

Select on which device types this control displays:

• Desktop: The control displays only on desktop devices. Enable the Show for Desktop toggle key.

• Mobile: The control displays only on mobile devices. Enable the Show for Mobile toggle key.

• Both: The control displays on both desktop and mobile devices. Both toggle keys are enabled by default.

CSS Selector Name

Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.

Then, use this name in the Custom CSS feature to apply CSS styling to this control as follows:

[selector='Submit Form'] {
    color: blueviolet;
}

See the following best practices regarding custom CSS in Screens:

• Editing a CSS name to represent this control in custom CSS syntax

• Visibility rules override custom CSS settings