The File Picker form element allows the user to select one or more files from the file system.
To use a file picker, the user clicks Add File (), selects one or more files (
), and then clicks Open. The selected files (
) are listed on the form. If the user picked fewer files than the maximum that you configured, then the user can click Add File again and select additional files. To remove a file from the list, the user clicks the file's Delete button.
Example of the File Picker form element, shown in a Geocortex viewer
The Properties table describes the properties of the
Property names in Workflow Designer's Properties panel are written using the capitalization and spacing of a title. Property names in expressions are valid JavaScript identifiers and start with a lower case letter. Expressions are case sensitive. When you access a form element property in an expression, you must use the correct capitalization.
In the table below:
If a property can be accessed in both the Properties panel and expressions, then the table gives both versions of the name.
If a property's name in the table starts with a lower case letter, then you can only access the property in expressions.
If a property's name starts with a capital letter and the table does not give a name to use in expressions, then you can only access the property in the Properties panel.
Properties of the File Picker Form Element
Button Label |
Type: String The text that appears on the button that the user clicks to select a You can format the button's label using Markdown. |
Description |
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. |
Element ID |
Type: String The element's ID, which is used in other form elements and activities to access the element's properties 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 |
Enabled |
Type: Boolean Name in Properties Panel: Enabled Name to Use in Expressions: enabled Indicates whether the By default, To access the ${Display Form ID}.state.{Element ID}.enabled For example: $form1.state. |
error |
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. |
File Types |
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:
To access the ${Display Form ID}.state.{Element ID}.fileTypes For example: $form1.state.filePicker1.fileTypes |
Maximum Files |
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, The Required checkbox is intended as a quick way to do simple validation without having to add a To access the ${Display Form ID}.state.{Element ID}.require For example: $form1.state. |
styleName |
Type: String
Indicates the name of the style that will be applied to the element. To access the ${Display Form ID}.state.{Element ID}.styleName For example: $form1.state. |
Title |
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. |
Tooltip |
Type: String A message that displays when the user hovers the mouse pointer over the |
type |
Type: String The variety of form element. Use the To access the ${Display Form ID}.state.{Element ID}.type For example: $form1.state.filePicker1.type |
value |
Type: FilesRef An object of type FilesRef that represents the selected file or files. The object has a ${Display Form ID}.state.{Element ID}.value.files For example: $form1.state.filePicker1.value.files |
Visible |
Type: Boolean Name in Properties Panel: Visible Name to Use in Expressions: visible Indicates whether the element is visible to the user. By default, To access the ${Display Form ID}.state.{Element ID}.visible For example: $form1.state.filePicker1.visible |
The following table describes the events associated with the
Events for the File Picker Form Element
load |
The You can use the |
change |
The You can use the The |
validate |
The You can use the If you use a Set Form Element Error activity, make sure you also use a Clear Form Element Error activity to clear the error. Otherwise the form may get stuck in an invalid state. By default, the Required property does not work when the For an example, see Example - Subworkflow for a Validate Event. |