# GraffitiUploaderSingle
Class Inherits GraffitiWebUIControl
## About
GraffitiUploaderSingle is a diverse single file upload control with chunked data transfer for efficient and correct transfers.
## Compatibility
### Framework API Version
| 1.0 | 2.0 |
| :---: | :---: |
| True | True |
### Web
| 32-Bit | 64-Bit |
| :---: | :---: |
| True | True |
## Event Definitions
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| FileCleared | (None) | (None) | Value has been cleared by the user. |
| FileSelected | (None) | (None) | A file has been selected by the user. |
| Open | (None) | (None) | |
| Shown | (None) | (None) | |
| UploadBegun | (None) | (None) | The upload process has started. |
| UploadCompleted | (None) | (None) | The upload process has completed. |
| UploadProgress | value as Double | (None) | The upload process has progressed. |
## Methods
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| AcceptedTypes | (None) | String | Returns an array of the selectable file types. |
| AcceptedTypes | value() as String | (None) | Returns an array of the selectable file types. |
| Constructor | (None) | (None) | Creates a new instance of the class. |
| IsUploading | (None) | Boolean | Returns whether an upload operation is currently active. |
| PreviewTypes | (None) | String | Returns an array of file MIME types that are currently automatically previewed. |
| PreviewTypes | value() as String | (None) | Returns an array of file MIME types that are currently automatically previewed. |
| Reset | (None) | (None) | Resets the control to its default state. |
| Upload | (None) | (None) | Signals the client to begin uploading. |
| Value | (None) | GraffitiWebFile | Returns the current GraffitiWebFile value. |
## Properties
| Name | Type | Default Value | Description |
| --- | :---: | :---: | --- |
| AllowFileDrops | Boolean | Nil | Controls whether users can drag and drop files to select. |
| AutoUpload | Boolean | Nil | When True, once a user has selected an acceptable file, the upload will automatically commence. |
| ClearButtonIndicator | Indicators | Nil | Indicator applied to the clear button. |
| ClearButtonStyle | GraffitiStyle | Nil | GraffitiStyle applied to the clear button. |
| ClearButtonText | String | Nil | Text or HTML caption of the clear button. Also accepts FontAwesome icon definitions. |
| ClearButtonTooltip | String | Nil | Text displayed in the tooltip of the clear button. |
| ClearButtonVisible | Boolean | Nil | Determines whether the clear button will be present in the control's UI. |
| Enabled | Boolean | Nil | |
| MaximumFileSize | Integer | Nil | Maximum allowed file size in bytes. 0 = Unlimited. |
| PreviewIndicator | Indicators | Nil | Indicator applied to the preview area. May be obscured by the file preview itself. |
| PreviewPopover | Boolean | Nil | When True and the user holds their cursor over the preview area, a larger preview of the selected file will be shown. |
| PreviewStyle | GraffitiStyle | Nil | WebStyle applied to the preview area. |
| PreviewVisible | Boolean | Nil | Determines whether the preview area will be present in the control's UI when a selection has been made. |
| ProgressBackgroundIndicator | Indicators | Nil | Indicator applied to the background of the progress bar during upload processes. |
| ProgressBackgroundStyle | GraffitiStyle | Nil | GraffitiStyle applied to the background of the progress bar during upload processes. |
| ProgressForegroundIndicator | Indicators | Nil | Indicator applied to the value and text displayed within the progress bar during upload processes. |
| ProgressForegroundStyle | GraffitiStyle | Nil | GraffitiStyle applied to the value and text displayed within the progress bar during upload processes. |
| ResetWhenComplete | Boolean | Nil | When True, the control will reset to no value when an upload has completed. |
| SelectButtonIndicator | Indicators | Nil | Indicator applied to the select button. |
| SelectButtonStyle | GraffitiStyle | Nil | GraffitiStyle applied to the select button. |
| SelectButtonText | String | Nil | Text or HTML within the select button. |
| SelectButtonTooltip | String | Nil | Text displayed within the select button's tooltip. |
| SelectButtonVisible | Boolean | Nil | Determines whether the select button will be present in the control's UI. |
| TemplateFileSelected | String | Nil | Template text that is parsed to display selection information. |
| TemplateProgress | String | Nil | Template text that is parsed to display upload progress information. |
| TemplateUploadComplete | String | Nil | Template text that is parsed to display information when an upload has completed. |
| TextDragOver | String | Nil | Text or HTML displayed within the control's label when a file is dragged over it. |
| TextFileRejected | String | Nil | Text or HTML displayed when the user has attempted to select or drop a file that is not allowed by the AcceptedTypes defined. |
| TextFileTooLarge | String | Nil | Text or HTML displayed when the user has attempted to select or drop a file that is larger than the MaximumFileSize property's value. |
| TextNoValue | String | Nil | Text or HTML displayed when no file is currently selected. |
| UploadButtonIndicator | Indicators | Nil | Indicator applied to the Upload button. |
| UploadButtonStyle | GraffitiStyle | Nil | GraffitiStyle applied to the Upload button. |
| UploadButtonText | String | Nil | Text or HTML displayed in the upload button. |
| UploadButtonTooltip | String | Nil | Text displayed in the upload button's tooltip. |
| UploadButtonVisible | Boolean | Nil | Determines whether the upload button will be present in the control's UI. |
| UploadPath | FolderItem | Nil | Path to store uploaded files. Defaults Xojo Cloud: SpecialFolder.Documents.Child( "com.graffitisuite.uploader" ) All others debug: SpecialFolder.Temporary.Child( "com.graffitisuite.uploader" ) All others built: SpecialFolder.ApplicationData.Child( "com.graffitisuite.uploader" ) |
