Image Control Settings

Add a control that displays an image.

Control Description

The Image control has the following functionality:

• The Image control displays a specified image that is GIF, JPG, or PNG file types.

• The image control may reference another control's Variable Name setting to display its value, such as to display the signature saved in a Signature control. The Signature control saves the signature as a PNG image.

This control is only available for the following Screen types:

• Display type

• Form type

See Screen Types.

Permissions Required

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.

Add the Control to a Screen

Permissions Required

Permissions are required to do this.

Design Best Practice

Avoid designing with more than 25 controls in one Screen.

Follow these steps to add this control to the Screen:

1. Create a new Screen or click the Edit iconto edit the selected Screen. The Screen is in Design mode.
2. View the Screen page to which to add the control.

3. Locate the Image iconin the panel to the left of the Screen Builder canvas.
4. Drag the Image icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.

5. Place into the Screen Builder canvas where you want the control to display on the Screen.

   
6. Configure the Image control. See Settings.

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

Below is an Image control in Preview mode.

Image control in Preview mode

Move the Control on the Page

After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.

Permissions are required to do this.

Follow these steps to move a control to another location on that Screen page:

1. Place your cursor anywhere on the control not displaying the Duplicate Controlor Delete Controlbuttons.
2. Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, theicon displays in the preview.
3. Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

Copy the Control with its Settings

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.

Permissions are required to do this.

Follow these steps to copy a control:

1. Select the control to be copied.

2. Click the Duplicate Control button. The control copies with its current settings, and then displays below other controls placed on that page.

Delete the Control from a Screen

Permissions are required to do this.

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.

Follow these steps to delete a control from a Screen page:

1. Select the control to be deleted.

2. Click the Delete button. The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

Permissions are required to do this.

The Image control has the following panels that contain settings:

• Configuration panel

• Design panel

• Advanced panel

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Image control in the Configuration panel:

• Name

• Upload

• Preview

• Render Image from a Variable Name

• Helper Text

Name

Enter the alphanumeric name that identifies the image in this Screen.

Upload

Click the Upload button to browse for the GIF, JPG, or PNG file type image to upload to the Image control.

Preview

Preview the uploaded image.

Render Image from a Variable Name

Select the Render image from a variable name setting to render as an image the content of another control by referencing that control's Variable Name setting value. For example, render an image of a signature from the Signature control.

Do not use this setting to display a file referenced from a File Upload control.

After selecting the Render image from a variable name setting, the Variable Name setting displays.

In the Variable Name setting, enter the Request variable name setting value of the content to display as an image in the Image control. This Request variable must contain the content of the image. For example, to display a digital signature entered into a Signature control with a Variable Name setting of SignDocument, enter SignDocument. If the Signature control has been signed, that digital signature displays in the Image control when it displays.

Helper Text

Enter text that provides additional guidance on this control's use. This setting has no default value.

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Image control in the Design panel:

• Height

• Width

Height

Enter the height of the uploaded image in pixels. If the Width setting has no value, the Image control adjusts the uploaded image to the Height setting value.

Width

Enter the width of the uploaded image in pixels. If the Height setting has no value, the Image control adjusts the uploaded image to the Width setting value.

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Image control in the Advanced panel:

• Visibility Rule

• CSS Selector Name

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.

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.

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.

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

Related Topics

pageScreen TypespageScreen Builder ModespageValidate Your ScreenpageEdit Your ScreenpageCheckbox Control SettingspageDate Picker Control SettingspageFile Download Control SettingspageFile Preview Control SettingspageFile Upload Control SettingspageGoogle Places Control SettingspageLine Input Control SettingspageLoop Control SettingspageMulticolumn / Table Control SettingspageNested Screen Control SettingspagePage Navigation Control SettingspageRecord List Control SettingspageRich Text Control SettingspageSelect List Control SettingspageSignature Control SettingspageSubmit Button Control SettingspageTextarea Control SettingspageExpression Syntax ComponentspageValidation Rules for "Validation Rules" SettingspageReference Magic Variables in ProcessMaker Platform Assets