|
The themed File Upload widget is available in ThingWorx 9.3.4 or later.
|
Consider listing the supported file types in the drop zone label. |
Property Name | Description | Base Type | Defualt Value | Bindable (Y\N) | Localizable (Y\N) |
---|---|---|---|---|---|
BrowseButtonLabel | Sets the label of the Browse button. | STRING | Browse | Y | Y |
BrowseButtonType | Sets the Browse button type. Options: Primary, Secondary, Tertiary | STRING | Primary | N | N |
ClearList | A bindable service that clears the list of selected files. | Service | n/a | Y | N |
CustomClass | Sets the CSS class to apply to the top div element of the widget. You can enter multiple classes, separated by a space. | STRING | n/a | Y | N |
DisableInstantUpload | Disables instant upload when a file is select | BOOLEAN | False | ||
DropZoneHeight | Sets the height of the file drop zone. | NUMBER | 96 | ||
DropZoneIcon | Sets the icon to display within the drop zone. | IMAGELINK | n/a | ||
DropZoneLabel | Sets the label of the drop zone. | STRING | Drag files here or click to browse | ||
FileNames | Contains the names of the selected files. | STRING | n/a | Y | N |
FileUploadMode | Specifies how files are selected at run time. You can drag and drop, or show a browse button. | STRING | Drag and Drop | N | N |
RepositoryName | The name of the file repository used by the widget. | THINGNAME | SystemRepository | Y | N |
ShowRespositorySelector | Displays whether the destination file repository should be editable. | BOOLEAN | True | N | N |
Path | The folder path to upload files to on the repository. | STRING | n/a | Y | N |
MultiFilesSelect | Enables multiple file selection. | BOOLEAN | False | N | N |
ShowDataLoading | Displays a spinning icon when data is loading. | BOOLEAN | True | N | N |
Width | The width of the widget. | NUMBER | 302 | N | |
Height | The height of the widget. | NUMBER | 95 | N | N |
Visible | Sets the visibility of the widget at run time. | True | True | N | N |
ClearList | Clears list of files added to the widget. | n/a | n/a | Y | N |
DisbaleInstantUpload | Disables instant upload after a file is selected. when set to false, files are only uploaded after the upload button is clicked. | False | False | Y | N |
ResetToDefaultValue | Resets the inputs for the widget to their default values. | n/a | n/a | Y | N |
ShowDeleteAllButton | shows delete all button and allows users to cancel the upload and delete all uploaded files. | BOOLEAN | False | N | N |
ShowRepositoryPath | Enables users to specify a path within the repository using a text field. | BOOLEAN | True | N | N |
ShowRepositorySelector | Displays a drop-down list that enables users to select the ThingWorx repository to upload files to. | BOOLEAN | True | N | N |
ShowUploadButton | Displays an upload button that uploads selected files. This property is only available when InstantUpload is set to false. | BOOLEAN | False | N | N |
UploadComplete | A bindable event that triggers when the file upload is complete. | n/a | n/a | Y | N |
Upload | A bindable service that uploads the selected files. | Service | |||
UploadDescription | Sets the description text that is used to guide users on what files to upload. | n/a | n/a | Y | N |
UploadDescriptionType | The type of label used to display the description text. | Body | Body | N | N |
UploadStarted | A bindable event that triggers when the upload starts. | n/a | n/a | Y | N |
UploadFailed | A bindable event that triggers when a file fails to upload. | n/a | n/a | Y | N |
Only the Invalid state is available when styling the failure messages on the Style Properties panel. |
Name | Description | Base Type | Default Value | Bindable? | Localizable? | ||
---|---|---|---|---|---|---|---|
AllowedFileTypes | Sets the allowed files types that users can select, separated by comma. For example: .png, .pdf, .txt | STRING | N/A | Y | N | ||
AllowedFileTypesMessage | The message to display when an unsupported file type is added. | STRING | Y | Y | |||
AllowedFileTypesMessageDetails | The details to display under the message which lists the allowed file types. | STRING | Y | Y | |||
CriteriaMessage | The message to display for the validation criteria and when the validation fails. | STRING | Y | Y | |||
CriteriaMessageDetails | The details to display for the validation criteria and failure message. | STRING | Y | Y | |||
FileRequired | Require a file to upload. | BOOLEAN | False | Y | N | ||
FileRequiredMessage | The message to display when a required file is missing. | STRING | Y | Y | |||
FileUploadErrorDetails | A message that displays additional details about files that failed to upload. | STRING | Y | Y | |||
FileUploadErrorMessage | The message to display when a file fails to upload. | STRING | Y | Y | |||
MaxFileSize | Sets a maximum size limit on each individual file in megabytes. | NUMBER | N/A | Y | N | ||
MaxFileSizeFailureMessage | The message to display when a file exceeds the maximum allowed file size. | STRING | Y | Y | |||
MaxFileSizeFailureTitle | The title of the dialog box that is displayed when the file size exceeds the maximum allowed file size. | STRING | Y | Y | |||
MaxNumberOfFiles | Sets the maximum number of files that you can add to the upload list. | NUMBER | N/A | Y | Y | ||
MaxNumberOfFilesFailureMessage | The message to display when the number of files added exceeds the maximum. | STRING | Y | Y | |||
MaxUploadSize | Sets a maximum size limit in megabytes for the upload when multiple files are selected. | NUMBER | N/A | Y | N | ||
MaxUploadSizeFailureMessage | The message to display when the total files size exceeds the maximum allowed file size. | STRING | Y | Y | |||
MaxUploadSizeFailureTitle | The title of the dialog box that is displayed when the total file size exceeds the maximum allowed value. | STRING | Y | Y | |||
ShowValidationFailure | Displays a failure message when the validation fails. | BOOLEAN | False | Y | N | ||
ShowValidationState | A bindable service that enables you to display the validation state before a user interacts with the widget at run time. By default, the validation state is only displayed after user interaction.
| Service | n/a | In | N | ||
Validate | An event that triggers when the widget value is changed. Bind this event to service or function to apply a validation pattern or expression. | Event | N/A | Y | N | ||
ValidationFailureIcon | Sets the SVG icon to display within the status message when the validation fails. | IMAGELINK | cds:icon_error | N | N | ||
ValidationOutput | Retrieves the output of the widget validation. Returned values are Undefined, Unvalidated, Valid, or Invalid. | STRING | N/A | Y | N | ||
ValidationState | A bindable property that sets the validation state. You can set this property to Undefined, Unvalidated, Valid, or Invalid. | STRING | Undefined | Y | N |