File Picker Form Element

Type: String

The text that appears on the button that the user clicks to select a file. The default text is Add File.

You can format the button's label using Markdown.

Type: String

A description of the element. The description appears below the element's title.

You can use the Description property to describe what the element represents or to provide instructions to the user about how to use the element.

You can format the description using Markdown.

Type: String

The element's ID, which is used in other form elements and activities to access the element's properties, including the user's input. The ID must be unique across all elements in the form.

You cannot get or set the value of the Element ID property in an expression—you can only use the value that you configured for it. To use the Element ID property in an expression:

${Display Form ID}.state.{Element ID}.{property name}

For example:

$form1.state.filePicker1.visible

Type: Boolean

Name in Properties Panel: Enabled

Name to Use in Expressions: enabled

Indicates whether the file picker is enabled in the running workflow. When a file picker is enabled, the user can select files. When a file picker is disabled, the user can see the file picker but cannot interact with it. Disabled elements appear dimmed or shaded in the running workflow.

By default, file pickers are enabled. To disable a file picker, clear the Enabled checkbox. You may want to change the property's value at run time depending on the user's input in a previous form element.

To access the enabled property in an expression:

${Display Form ID}.state.{Element ID}.enabled

For example:

$form1.state.filePicker1.enabled

Type: String | MarkdownRef

Indicates whether an error occurred in the element.

We recommend using the Set Form Element Error and Clear Form Element Error activities to work with errors in form elements.

Type: String

Name in Properties Panel: File Types

Name to Use in Expressions: fileTypes

The types of files that the user can select. Use commas to separate the file types. If you leave the File Types property blank, the user can select any type of file.

You can specify either file extensions or MIME types, for example:

• .xml - Accepts XML files

• .png, .jpg, .jpeg - Accepts PNG, JPG, and JPEG files

• image/png - Accepts files with the image/png MIME type

• image/* - Accepts files with an image/* MIME type

• * - Accepts all file types

To access the fileTypes property in an expression:

${Display Form ID}.state.{Element ID}.fileTypes

For example:

$form1.state.filePicker1.fileTypes

Type: Number

The maximum number of files that the user can select. If you do not specify the maximum, the user will be able to select 3 files.

Type: Boolean

Name in Properties Panel: Required

Name to Use in Expressions: require

Indicates whether the user must select a file. When the file picker is required, the user cannot submit the form until at least one file is selected.

By default, file pickers are not required. To require a file picker, select the Required checkbox.

The Required checkbox is intended as a quick way to do simple validation without having to add a validate event. If you add a validate event to a form element, selecting the Required checkbox will not have any effect. In this case, you must make the validate event check whether the user entered a value.

To access the require property in an expression:

${Display Form ID}.state.{Element ID}.require

For example:

$form1.state.filePicker1.require

Type: String

Indicates the name of the style that will be applied to the element.

To access the styleName property in an expression:

${Display Form ID}.state.{Element ID}.styleName

For example:

$form1.state.filePicker1.styleName

Type: String

The element's title, which appears at the top of the element. You may want to change the title to describe what the element represents in your workflow.

You can format the title using Markdown.

Type: String

A message that displays when the user hovers the mouse pointer over the file picker. You may want to use the tooltip to provide help to the user.

Type: String

The variety of form element. File pickers are type "FilePicker".

Use the type property to find out the variety of a form element in a form with many elements. Loop through ${Display Form ID}.state, comparing each element to the known form types and performing some action on the elements that meet your type criteria.

To access the type property in an expression:

${Display Form ID}.state.{Element ID}.type

For example:

$form1.state.filePicker1.type

Type: FilesRef

An object of type FilesRef that represents the selected file or files. The object has a files property that is the collection of files. To access the collection in an expression:

${Display Form ID}.state.{Element ID}.value.files

For example:

$form1.state.filePicker1.value.files

The load event fires when the element finishes loading.

You can use the load event to set one or more of the element's properties at run time.

The change event fires when the user adds a file.

You can use the change event to create dependencies between form elements. For example, you could configure a change subworkflow that enables or disables other form elements depending on the user's selection.

The change event fires every time the user adds a file. This means that the change subworkflow can run multiple times. Because of this, you should make sure that the change subworkflow is not computationally intensive or long running.