Gallery Field Type

TABLE OF CONTENTS

• Basic Properties
  • Data Name
  • Gallery Title
  • Hint Text
  • Prompt User for Default Caption
    • In-App Prompts/Display
• Layout & Styling
  • Background Color
• Validation & Behavior
  • Required
  • Validation Behavior
  • Gallery Item Limits
• Displaying in an Output Template

This is an advanced field type that allows a user to upload multiple images into a form from a device's gallery and capture images using the device's camera, displaying al. The form displays all images as thumbnails. Other field types can be added to the Gallery field, allowing for image captions, comments, or any additional information required. 

 Note: A maximum of 6 images can be added at a time. If you wish to add more than 6 images, please consider instead using a repeating table with a media field inside. See this article for more on repeating tables.

1. Add a Gallery Field.
2. Add a Text field into the Gallery field and assign a data name.
3. Add the data name of the Text field into the Gallery Field's "Prompt User for Default Caption" property.
4. Optional - Add other field types to capture additional data (comments, location, etc.).

---

Basic Properties

Data Name

This is the name of the field that should be referenced in any form logic or API calls. Users will not see this name on the form.

Data names cannot contain spaces or any special characters other than an underscore and must begin with a letter. They are case-sensitive and must be referred to precisely whenever they are referenced.

Gallery Title

This is the name of the field that will be displayed to users on the app. This property is completely optional; while a field must contain a data name, a field title is optional.

The text color may be chosen with a hex code. The text may be also formatted as Bold or Italic and given a relative size -- Small, Medium (the default), or Large.

Hint Text

This optional field can be used to show secondary information to the user in the app. Consider using this to provide instruction or clarification to the user as they fill out the field.

Formatting options for this property are the same as those given available for the Title Text property.

Prompt User for Default Caption

If the gallery field is selected, the app will prompt the user to input a default caption for all images selected at a time. Here you may specify the data name of a text field that will serve as this default caption text.

 

---

In-App Prompts/Display

Within the app, the Gallery field will display a Choose/Capture option. When selecting either option, you'll be able to select multiple images or capture a single image and then type a caption that will display below all images from that instance.

Edit your images and captions by simply selecting the image thumbnail. You can also edit the image's additional fields and annotate the image.

Layout & Styling

Background Color

The color chosen in the hex code field here will apply to the field. The Transparent box can also be chosen instead for making this transparent instead of a solid color.

Validation & Behavior

Required

Checking this box will enforce validation against this field to make the field required, disallowing the user from progressing to the next page or submitting the form if it is left blank. If the user tries, they will be prompted with an error to return to the field and enter a value. When this validation occurs is determined by the "Validation Property" chosen on the page level; please see this article for more detail on this.

This property can also be made conditional based on a formula. To enable this, click "add condition" below the checkbox and enter a formula into the field that populates. The formula serves as the basis of the required-ness of this field.

Please see this article for more information on conditionally-required fields.

---

Validation Behavior

This drop-down specifies how the fields in this gallery should be validated.

• Inline validation occurs immediately after the user has entered a value into a field.
• Page Change validation occurs when the user tries to navigate away from a gallery page.
• End of Form validation allows the user to leave a row page while fields are invalid, only performing validation checks when the entry is to be uploaded.

Gallery Item Limits

This checkbox option enables validation of the minimum and/or maximum number of images that a gallery can contain. This is useful for scenarios where the number of displayed/uploaded images needs to be controlled.

---

Output Gallery Field Data in a Custom Word/Excel Template

As noted previously in this article, the gallery field type is a repeatable field type, like the table field, and therefore, to output the data it contains in a template, it must be encased in a REPEATROW or REPEATSTART. 

To display images and other content captured by a Gallery field on your output template, please refer to the syntax defined in our Repeating Data article.

{{!REPEATSTART|3}}

{{gallery1_media}}	{{gallery1_media}}	{{gallery1_media}}
{{caption_default}}	{{caption_default}}	{{caption_default}}

{{!REPEATEND}}

---