FileUploader.xml

<?xml version="1.0" encoding="utf-8" ?>
<widget id="com.mendix.widget.web.fileuploader.FileUploader" pluginWidget="true" needsEntityContext="true" offlineCapable="true" supportedPlatform="Web" xmlns="http://www.mendix.com/widget/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mendix.com/widget/1.0/ ../node_modules/mendix/custom_widget.xsd">
    <name>File uploader</name>
    <description />
    <studioProCategory>Images, videos &amp; files</studioProCategory>
    <studioCategory>Images, Videos &amp; Files</studioCategory>
    <icon />
    <properties>
        <propertyGroup caption="General">
            <property key="uploadMode" type="enumeration" defaultValue="files">
                <caption>Upload mode</caption>
                <description />
                <enumerationValues>
                    <enumerationValue key="files">Files</enumerationValue>
                    <enumerationValue key="images">Images</enumerationValue>
                </enumerationValues>
            </property>
            <property key="associatedFiles" type="datasource" isList="true" defaultType="Association" defaultValue="FileUploader.FileUploadContext/FileUploader.UploadedFile_FileUploadContext/FileUploader.UploadedFile">
                <caption>Associated files</caption>
                <description />
            </property>
            <property key="associatedImages" type="datasource" isList="true" defaultType="Association" defaultValue="FileUploader.FileUploadContext/FileUploader.UploadedImage_FileUploadContext/FileUploader.UploadedImage">
                <caption>Associated images</caption>
                <description />
            </property>
            <property key="readOnlyMode" type="boolean" defaultValue="false">
                <caption>Read-only mode</caption>
                <description />
            </property>
            <property key="createFileAction" type="action" defaultValue="FileUploader.ACT_CreateUploadedFileDocument" defaultType="CallNanoflow">
                <caption>Action to create new files</caption>
                <description>Nanoflow that creates a file object, associates it to the current object and commits it.</description>
            </property>
            <property key="createImageAction" type="action" defaultValue="FileUploader.ACT_CreateUploadedImageDocument" defaultType="CallNanoflow">
                <caption>Action to create new images</caption>
                <description>Nanoflow that creates an image object, associates it to the current object and commits it.</description>
            </property>
            <property key="allowedFileFormats" type="object" isList="true" required="false">
                <caption>Allowed file formats</caption>
                <description>No restrictions if left empty.</description>
                <properties>
                    <propertyGroup caption="General">
                        <property key="configMode" type="enumeration" defaultValue="simple">
                            <caption>Configuration mode</caption>
                            <description />
                            <enumerationValues>
                                <enumerationValue key="simple">Simple</enumerationValue>
                                <enumerationValue key="advanced">Advanced</enumerationValue>
                            </enumerationValues>
                        </property>
                        <property key="predefinedType" type="enumeration" defaultValue="pdfFile">
                            <caption>Predefined type</caption>
                            <description />
                            <enumerationValues>
                                <enumerationValue key="pdfFile">PDF Document (.pdf)</enumerationValue>
                                <enumerationValue key="msWordFile">Microsoft Word (.doc and .docx)</enumerationValue>
                                <enumerationValue key="msExcelFile">Microsoft Excel (.xls and .xlsx)</enumerationValue>
                                <enumerationValue key="msPowerPointFile">Microsoft PowerPoint (.ppt and .pptx)</enumerationValue>
                                <enumerationValue key="plainTextFile">Plain Text (.txt)</enumerationValue>
                                <enumerationValue key="csvFile">CSV (.csv)</enumerationValue>
                                <enumerationValue key="zipArchiveFile">Zip archive</enumerationValue>
                                <enumerationValue key="anyTextFile">Text file</enumerationValue>
                                <enumerationValue key="anyImageFile">Image</enumerationValue>
                                <enumerationValue key="anyAudioFile">Audio</enumerationValue>
                                <enumerationValue key="anyVideoFile">Video</enumerationValue>
                            </enumerationValues>
                        </property>
                        <property key="mimeType" type="string" required="false">
                            <caption>Mime Type</caption>
                            <description>For example &apos;image/jpeg&apos; or &apos;application/pdf&apos;</description>
                        </property>
                        <property key="extensions" type="string" required="false">
                            <caption>Extensions list</caption>
                            <description>Comma separated list of extensions. For example: &apos;.jpg,.jpeg&apos;.</description>
                        </property>
                        <property key="typeFormatDescription" type="textTemplate">
                            <caption>Type description</caption>
                            <description>Shown to the end users to describe supported file types.</description>
                        </property>
                    </propertyGroup>
                </properties>
            </property>
            <property key="maxFilesPerUpload" type="expression" defaultValue="10">
                <caption>Maximum number of files</caption>
                <description>Limit the number of files per upload.</description>
                <returnType type="Integer" />
            </property>
            <property key="maxFileSize" type="integer" defaultValue="25">
                <caption>Maximum file size (MB)</caption>
                <description>Reject files that are bigger than specified size.</description>
            </property>
        </propertyGroup>
        <propertyGroup caption="Texts">
            <property key="dropzoneIdleMessage" type="textTemplate">
                <caption>Dropzone message</caption>
                <description />
                <translations>
                    <translation lang="en_US">Drag and drop files here</translation>
                </translations>
            </property>
            <property key="dropzoneAcceptedMessage" type="textTemplate">
                <caption>Dropzone hover for uploadable files</caption>
                <description />
                <translations>
                    <translation lang="en_US">All files can be uploaded.</translation>
                </translations>
            </property>
            <property key="dropzoneRejectedMessage" type="textTemplate">
                <caption>Dropzone hover for non uploadable files</caption>
                <description />
                <translations>
                    <translation lang="en_US">Some files may not be uploadable.</translation>
                </translations>
            </property>
            <property key="uploadInProgressMessage" type="textTemplate">
                <caption>Uploading in progress</caption>
                <description />
                <translations>
                    <translation lang="en_US">Uploading...</translation>
                </translations>
            </property>
            <property key="uploadSuccessMessage" type="textTemplate">
                <caption>Uploading success</caption>
                <description />
                <translations>
                    <translation lang="en_US">Uploaded successfully.</translation>
                </translations>
            </property>
            <property key="uploadFailureGenericMessage" type="textTemplate">
                <caption>Uploading unknown error</caption>
                <description />
                <translations>
                    <translation lang="en_US">An error occurred during uploading.</translation>
                </translations>
            </property>
            <property key="uploadFailureInvalidFileFormatMessage" type="textTemplate">
                <caption>Invalid file format</caption>
                <description />
                <translations>
                    <translation lang="en_US">File format is not supported, supported formats are ###.</translation>
                </translations>
            </property>
            <property key="uploadFailureFileIsTooBigMessage" type="textTemplate">
                <caption>File is too big</caption>
                <description />
                <translations>
                    <translation lang="en_US">File size exceeds the maximum limit of ### megabytes.</translation>
                </translations>
            </property>
            <property key="uploadFailureTooManyFilesMessage" type="textTemplate">
                <caption>Too many files</caption>
                <description />
                <translations>
                    <translation lang="en_US">Too many files added. Only ### files per upload are allowed.</translation>
                </translations>
            </property>
            <property key="unavailableCreateActionMessage" type="textTemplate">
                <caption>Action to create new files is not available or failed</caption>
                <description />
                <translations>
                    <translation lang="en_US">Can&apos;t upload files at this time. Please contact your system administrator.</translation>
                </translations>
            </property>
            <property key="downloadButtonTextMessage" type="textTemplate">
                <caption>Download button</caption>
                <description />
                <translations>
                    <translation lang="en_US">Download this file</translation>
                </translations>
            </property>
            <property key="removeButtonTextMessage" type="textTemplate">
                <caption>Remove button</caption>
                <description />
                <translations>
                    <translation lang="en_US">Remove this file</translation>
                </translations>
            </property>
            <property key="removeSuccessMessage" type="textTemplate">
                <caption>File removal success</caption>
                <description />
                <translations>
                    <translation lang="en_US">Removed successfully.</translation>
                </translations>
            </property>
            <property key="removeErrorMessage" type="textTemplate">
                <caption>File removal failure</caption>
                <description />
                <translations>
                    <translation lang="en_US">An error occurred while removing this file.</translation>
                </translations>
            </property>
        </propertyGroup>
        <propertyGroup caption="Advanced">
            <property key="objectCreationTimeout" type="integer" defaultValue="10">
                <caption>Object creation timeout</caption>
                <description>Consider uploads unsuccessful if the Action to create new files/images does not create new objects within the configured amount of seconds.</description>
            </property>
            <property key="enableCustomButtons" type="boolean" defaultValue="false">
                <caption>Enable custom buttons</caption>
                <description />
            </property>
            <property key="customButtons" type="object" isList="true" required="false">
                <caption>Custom buttons</caption>
                <description />
                <properties>
                    <propertyGroup caption="General">
                        <property key="buttonCaption" type="textTemplate">
                            <caption>Caption</caption>
                            <description />
                        </property>
                        <property key="buttonIcon" type="icon">
                            <caption>Icon</caption>
                            <description />
                        </property>
                        <property key="buttonActionFile" type="action" dataSource="../associatedFiles">
                            <caption>Action</caption>
                            <description />
                        </property>
                        <property key="buttonActionImage" type="action" dataSource="../associatedImages">
                            <caption>Action</caption>
                            <description />
                        </property>
                        <property key="buttonIsDefault" type="boolean" defaultValue="false">
                            <caption>Default file action</caption>
                            <description>When set to Yes, the action will be triggered by clicking on the file entry.</description>
                        </property>
                        <property key="buttonIsVisible" type="expression" defaultValue="true">
                            <caption>Visible</caption>
                            <description>The button will be hidden when false is returned.</description>
                            <returnType type="Boolean" />
                        </property>
                    </propertyGroup>
                </properties>
            </property>
        </propertyGroup>
    </properties>
</widget>