Class sap.ca.ui.FileUploadModule: sap/ca/ui/FileUpload

extends Control

Allows you to display a list of uploaded files. You can also upload a new one, rename or delete them

Deprecated API:Since version 1.26. This control is available in sap.m in 1.26, as sap.m.UploadCollection. Please use UploadCollection, as sap.ca.ui.FileUpload will not be supported anymore from 1.26.

Constructor Summary
new sap.ca.ui.FileUpload(sId?, mSettings?)Constructor for a new FileUpload.
Event Summary
beforeUploadFile(oControlEvent)Fired just before the control is about to make a file upload request.
deleteFile(oControlEvent)Fired when a file deletion event occurs typically by clicking a the delete icon.
fileUploadFailed(oControlEvent)Fired when a file fails to upload.
renameFile(oControlEvent)Fired when a file is renamed.
uploadFile(oControlEvent)Fired when a file is uploaded and the response comes back from service.
cancelClicked(oControlEvent)Fired when the cancel button is clicked.
saveClicked(oControlEvent)Fired when the save button is clicked.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ca.ui.FileUpload.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.FileUpload with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.FileUpload.getMetadata()Returns a metadata object for class sap.ca.ui.FileUpload.
attachBeforeUploadFile(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'beforeUploadFile' event of this sap.ca.ui.FileUpload.
attachDeleteFile(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'deleteFile' event of this sap.ca.ui.FileUpload.
attachFileUploadFailed(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'fileUploadFailed' event of this sap.ca.ui.FileUpload.
attachRenameFile(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'renameFile' event of this sap.ca.ui.FileUpload.
attachUploadFile(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'uploadFile' event of this sap.ca.ui.FileUpload.
destroyToolBar()Destroys the toolBar in the aggregation named toolBar.
destroyUploadProgressLabel()Destroys the uploadProgressLabel in the aggregation named uploadProgressLabel.
detachBeforeUploadFile(fnFunction, oListener)Detach event handler fnFunction from the 'beforeUploadFile' event of this sap.ca.ui.FileUpload.
detachDeleteFile(fnFunction, oListener)Detach event handler fnFunction from the 'deleteFile' event of this sap.ca.ui.FileUpload.
detachFileUploadFailed(fnFunction, oListener)Detach event handler fnFunction from the 'fileUploadFailed' event of this sap.ca.ui.FileUpload.
detachRenameFile(fnFunction, oListener)Detach event handler fnFunction from the 'renameFile' event of this sap.ca.ui.FileUpload.
detachUploadFile(fnFunction, oListener)Detach event handler fnFunction from the 'uploadFile' event of this sap.ca.ui.FileUpload.
fireBeforeUploadFile(mArguments?)Fire event beforeUploadFile to attached listeners.
fireDeleteFile(mArguments?)Fire event deleteFile to attached listeners.
fireFileUploadFailed(mArguments?)Fire event fileUploadFailed to attached listeners.
fireRenameFile(mArguments?)Fire event renameFile to attached listeners.
fireUploadFile(mArguments?)Fire event uploadFile to attached listeners.
getAcceptRequestHeader()Getter for property acceptRequestHeader.
getContributor()Getter for property contributor.
getDeleteEnabled()Getter for property deleteEnabled.
getEncodeUrl()Getter for property encodeUrl.
getFileExtension()Getter for property fileExtension.
getFileId()Getter for property fileId.
getFileName()Getter for property fileName.
getItems()Getter for property items.
getMimeType()Getter for property mimeType.
getMultipleSelectionEnabled()Getter for property multipleSelectionEnabled.
getRenameEnabled()Getter for property renameEnabled.
getSequentialUploadsEnabled()Getter for property sequentialUploadsEnabled.
getShowAttachmentsLabel()Getter for property showAttachmentsLabel.
getShowNoData()Getter for property showNoData.
getSize()Getter for property size.
getToolBar()Getter for aggregation toolBar.
getUploadedDate()Getter for property uploadedDate.
getUploadEnabled()Getter for property uploadEnabled.
getUploadProgressLabel()Getter for aggregation uploadProgressLabel.
getUploadUrl()Getter for property uploadUrl.
getUrl()Getter for property url.
getUseEditControls()Getter for property useEditControls.
getUseMultipart()Getter for property useMultipart.
getXsrfToken()Getter for property xsrfToken.
setAcceptRequestHeader(sAcceptRequestHeader)Setter for property acceptRequestHeader.
setEncodeUrl(sEncodeUrl)Setter for property encodeUrl.
setFileId(sFileId)Setter for property fileId.
setMultipleSelectionEnabled(bMultipleSelectionEnabled)Setter for property multipleSelectionEnabled.
setSequentialUploadsEnabled(bSequentialUploadsEnabled)Setter for property sequentialUploadsEnabled.
setShowNoData(bShowNoData)Setter for property showNoData.
setToolBar(oToolBar)Setter for the aggregated toolBar.
setUploadProgressLabel(oUploadProgressLabel)Setter for the aggregated uploadProgressLabel.
setUploadUrl(sUploadUrl)Setter for property uploadUrl.
setUseMultipart(bUseMultipart)Setter for property useMultipart.
setXsrfToken(sXsrfToken)Setter for property xsrfToken.
attachCancelClicked(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'cancelClicked' event of this sap.ca.ui.FileUpload.
attachSaveClicked(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'saveClicked' event of this sap.ca.ui.FileUpload.
destroyAttachmentNumberLabel()Destroys the attachmentNumberLabel in the aggregation named attachmentNumberLabel.
detachCancelClicked(fnFunction, oListener)Detach event handler fnFunction from the 'cancelClicked' event of this sap.ca.ui.FileUpload.
detachSaveClicked(fnFunction, oListener)Detach event handler fnFunction from the 'saveClicked' event of this sap.ca.ui.FileUpload.
fireCancelClicked(mArguments?)Fire event cancelClicked to attached listeners.
fireSaveClicked(mArguments?)Fire event saveClicked to attached listeners.
getEditMode()Getter for property editMode.
getShowAttachmentsLabelInEditMode()Getter for property showAttachmentsLabelInEditMode.
setAttachmentNumberLabel(oAttachmentNumberLabel)Setter for the aggregated attachmentNumberLabel.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ca.ui.FileUpload(sId?, mSettings?)
Constructor for a new FileUpload.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.26. This control is available in sap.m in 1.26, as sap.m.UploadCollection. Please use UploadCollection, as sap.ca.ui.FileUpload will not be supported anymore from 1.26.
Event Detail
beforeUploadFile(oControlEvent)
Fired just before the control is about to make a file upload request. The data passed is the file object selected by the user. You may handle this event to attach custom headers for example if your service implementation requires it.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
deleteFile(oControlEvent)
Fired when a file deletion event occurs typically by clicking a the delete icon. The file descriptor json for the file to be deleted is passed in the event data
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
fileUploadFailed(oControlEvent)
Fired when a file fails to upload. The error code and response data is passed in this event. The consumer should handle the error by showing the appropriate message.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
renameFile(oControlEvent)
Fired when a file is renamed. The file descripter json for the file to be renamed is passed in the event data and also a property, newFilename, that contains the new filename.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
uploadFile(oControlEvent)
Fired when a file is uploaded and the response comes back from service. The service response for the file to be added to the list is passed in the event data and the consumer must format it in the correct json structure and pass it back to the control using commitUploadFile method.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
cancelClicked(oControlEvent)
Fired when the cancel button is clicked. The consumer may handle the event if required.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Deprecated:
Since version 1.21.1. This method is deprecated now
saveClicked(oControlEvent)
Fired when the save button is clicked. The consumer should handle the event and save all the file renames to backend.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Deprecated:
Since version 1.21.1. This method is deprecated now. The rename or delete event is enough and should be use to commit the action immediatly
Method Detail
sap.ca.ui.FileUpload.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.FileUpload with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of informations as described in Element.extend.

Parameters:
{string}sClassName name of the class to be created
{object}oClassInfo? object literal with informations about the class
{function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
Returns:
{function} the created class / constructor function
sap.ca.ui.FileUpload.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ca.ui.FileUpload.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachBeforeUploadFile(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'beforeUploadFile' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired just before the control is about to make a file upload request. The data passed is the file object selected by the user. You may handle this event to attach custom headers for example if your service implementation requires it.

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
attachDeleteFile(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'deleteFile' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired when a file deletion event occurs typically by clicking a the delete icon. The file descriptor json for the file to be deleted is passed in the event data

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
attachFileUploadFailed(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'fileUploadFailed' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired when a file fails to upload. The error code and response data is passed in this event. The consumer should handle the error by showing the appropriate message.

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
attachRenameFile(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'renameFile' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired when a file is renamed. The file descripter json for the file to be renamed is passed in the event data and also a property, newFilename, that contains the new filename.

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
attachUploadFile(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'uploadFile' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired when a file is uploaded and the response comes back from service. The service response for the file to be added to the list is passed in the event data and the consumer must format it in the correct json structure and pass it back to the control using commitUploadFile method.

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
destroyToolBar(): sap.ca.ui.FileUpload
Destroys the toolBar in the aggregation named toolBar.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
destroyUploadProgressLabel(): sap.ca.ui.FileUpload
Destroys the uploadProgressLabel in the aggregation named uploadProgressLabel.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachBeforeUploadFile(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'beforeUploadFile' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachDeleteFile(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'deleteFile' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachFileUploadFailed(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'fileUploadFailed' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachRenameFile(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'renameFile' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachUploadFile(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'uploadFile' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireBeforeUploadFile(mArguments?): sap.ca.ui.FileUpload
Fire event beforeUploadFile to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireDeleteFile(mArguments?): sap.ca.ui.FileUpload
Fire event deleteFile to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireFileUploadFailed(mArguments?): sap.ca.ui.FileUpload
Fire event fileUploadFailed to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireRenameFile(mArguments?): sap.ca.ui.FileUpload
Fire event renameFile to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireUploadFile(mArguments?): sap.ca.ui.FileUpload
Fire event uploadFile to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
getAcceptRequestHeader(): string
Getter for property acceptRequestHeader. The Accept request header the control should use when sending the upload request

Default value is application/json

Returns:
{string} the value of property acceptRequestHeader
getContributor(): string
Getter for property contributor. Relative path in model, pointing to property that stores the name of the person who uploaded the file.

Default value is empty/undefined

Returns:
{string} the value of property contributor
getDeleteEnabled(): boolean
Getter for property deleteEnabled. Indicates whether delete functionality should be enabled

Default value is empty/undefined

Returns:
{boolean} the value of property deleteEnabled
getEncodeUrl(): string
Getter for property encodeUrl. Url of server that will base64 encode the file

Default value is empty/undefined

Returns:
{string} the value of property encodeUrl
getFileExtension(): string
Getter for property fileExtension. Relative path in model, pointing to property that stores the uploaded files extension. Note: either fileExtension or mimeType may be used, but mimeType is preferable.

Default value is empty/undefined

Returns:
{string} the value of property fileExtension
getFileId(): string
Getter for property fileId. An identifier property name that is used to uniquely reference the file on the server.

Default value is empty/undefined

Returns:
{string} the value of property fileId
getFileName(): string
Getter for property fileName. Relative path in model, pointing to property that stores the name of a file.

Default value is empty/undefined

Returns:
{string} the value of property fileName
getItems(): string
Getter for property items. The base path in the model for the control. Avoid trailing forward slashes in value, as per default value.

Default value is empty/undefined

Returns:
{string} the value of property items
getMimeType(): string
Getter for property mimeType. Relative path in model, pointing to property that stores the file's mimeType. Note: either fileExtension or mimeType may be used, but mimeType is preferable.

Default value is empty/undefined

Returns:
{string} the value of property mimeType
getMultipleSelectionEnabled(): boolean
Getter for property multipleSelectionEnabled. Indicates whether the user is allowed to select multiple file at once from his desktop

Default value is true

Returns:
{boolean} the value of property multipleSelectionEnabled
getRenameEnabled(): boolean
Getter for property renameEnabled. Indicates whether rename functionality should be enabled

Default value is empty/undefined

Returns:
{boolean} the value of property renameEnabled
getSequentialUploadsEnabled(): boolean
Getter for property sequentialUploadsEnabled. Indicates whether file uploads should occur sequentially or in parallel. The default is in parallel.

Default value is false

Returns:
{boolean} the value of property sequentialUploadsEnabled
getShowAttachmentsLabel(): boolean
Getter for property showAttachmentsLabel. Show the Attachments count label

Default value is true

Returns:
{boolean} the value of property showAttachmentsLabel
getShowNoData(): boolean
Getter for property showNoData. Show the label "No data" when the control doesn't have files

Default value is false

Returns:
{boolean} the value of property showNoData
getSize(): string
Getter for property size. Relative path in model, pointing to property that stores the size of a file.

Default value is empty/undefined

Returns:
{string} the value of property size
getToolBar(): sap.m.Toolbar
Getter for aggregation toolBar.
Aggregation that contains the buttons for adding
Returns:
{sap.m.Toolbar}
getUploadedDate(): string
Getter for property uploadedDate. Relative path in model, pointing to property that stores the date at which a file was uploaded.

Default value is empty/undefined

Returns:
{string} the value of property uploadedDate
getUploadEnabled(): boolean
Getter for property uploadEnabled. This property enables & disables the ability to upload a file

Default value is empty/undefined

Returns:
{boolean} the value of property uploadEnabled
getUploadProgressLabel(): sap.m.Label
Getter for aggregation uploadProgressLabel.
Aggregation that displays the current number of items that are being uploaded
Returns:
{sap.m.Label}
getUploadUrl(): string
Getter for property uploadUrl. Url of server we wish to upload to

Default value is empty/undefined

Returns:
{string} the value of property uploadUrl
getUrl(): string
Getter for property url. Relative path in model, pointing to property that stores the url at which the file is stored.

Default value is empty/undefined

Returns:
{string} the value of property url
getUseEditControls(): boolean
Getter for property useEditControls. Show the edit user controls to rename and delete files (same as deleteEnabled and renameEnabled)

Default value is false

Returns:
{boolean} the value of property useEditControls
getUseMultipart(): boolean
Getter for property useMultipart. Indicates if the control should send multipart/form data request when uploading

Default value is false

Returns:
{boolean} the value of property useMultipart
getXsrfToken(): string
Getter for property xsrfToken. The XSRF token the control should use when making the upload request. If it is not set, the control will not use a security token.

Default value is empty/undefined

Returns:
{string} the value of property xsrfToken
setAcceptRequestHeader(sAcceptRequestHeader): sap.ca.ui.FileUpload
Setter for property acceptRequestHeader.

Default value is application/json

Parameters:
{string}sAcceptRequestHeader new value for property acceptRequestHeader
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setEncodeUrl(sEncodeUrl): sap.ca.ui.FileUpload
Setter for property encodeUrl.

Default value is empty/undefined

Parameters:
{string}sEncodeUrl new value for property encodeUrl
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setFileId(sFileId): sap.ca.ui.FileUpload
Setter for property fileId.

Default value is empty/undefined

Parameters:
{string}sFileId new value for property fileId
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setMultipleSelectionEnabled(bMultipleSelectionEnabled): sap.ca.ui.FileUpload
Setter for property multipleSelectionEnabled.

Default value is true

Parameters:
{boolean}bMultipleSelectionEnabled new value for property multipleSelectionEnabled
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setSequentialUploadsEnabled(bSequentialUploadsEnabled): sap.ca.ui.FileUpload
Setter for property sequentialUploadsEnabled.

Default value is false

Parameters:
{boolean}bSequentialUploadsEnabled new value for property sequentialUploadsEnabled
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setShowNoData(bShowNoData): sap.ca.ui.FileUpload
Setter for property showNoData.

Default value is false

Parameters:
{boolean}bShowNoData new value for property showNoData
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setToolBar(oToolBar): sap.ca.ui.FileUpload
Setter for the aggregated toolBar.
Parameters:
{sap.m.Toolbar}oToolBar
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setUploadProgressLabel(oUploadProgressLabel): sap.ca.ui.FileUpload
Setter for the aggregated uploadProgressLabel.
Parameters:
{sap.m.Label}oUploadProgressLabel
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setUploadUrl(sUploadUrl): sap.ca.ui.FileUpload
Setter for property uploadUrl.

Default value is empty/undefined

Parameters:
{string}sUploadUrl new value for property uploadUrl
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setUseMultipart(bUseMultipart): sap.ca.ui.FileUpload
Setter for property useMultipart.

Default value is false

Parameters:
{boolean}bUseMultipart new value for property useMultipart
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
setXsrfToken(sXsrfToken): sap.ca.ui.FileUpload
Setter for property xsrfToken.

Default value is empty/undefined

Parameters:
{string}sXsrfToken new value for property xsrfToken
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
attachCancelClicked(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'cancelClicked' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired when the cancel button is clicked. The consumer may handle the event if required.

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Deprecated:
Since version 1.21.1. This method is deprecated now
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
attachSaveClicked(oData?, fnFunction, oListener?): sap.ca.ui.FileUpload
Attach event handler fnFunction to the 'saveClicked' event of this sap.ca.ui.FileUpload.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.FileUpload.
itself.

Fired when the save button is clicked. The consumer should handle the event and save all the file renames to backend.

Parameters:
{object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
{function}fnFunction The function to call, when the event occurs.
{object}oListener? Context object to call the event handler with. Defaults to this sap.ca.ui.FileUpload.
itself.
Deprecated:
Since version 1.21.1. This method is deprecated now. The rename or delete event is enough and should be use to commit the action immediatly
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
destroyAttachmentNumberLabel(): sap.ca.ui.FileUpload
Destroys the attachmentNumberLabel in the aggregation named attachmentNumberLabel.
Deprecated:
Since version 1.21.0. This aggregation is deprecatd now. The label is part of the ToolBar
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachCancelClicked(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'cancelClicked' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Deprecated:
Since version 1.21.1. This method is deprecated now
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
detachSaveClicked(fnFunction, oListener): sap.ca.ui.FileUpload
Detach event handler fnFunction from the 'saveClicked' event of this sap.ca.ui.FileUpload.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to call, when the event occurs.
{object}oListener Context object on which the given function had to be called.
Deprecated:
Since version 1.21.1. This method is deprecated now. The rename or delete event is enough and should be use to commit the action immediatly
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireCancelClicked(mArguments?): sap.ca.ui.FileUpload
Fire event cancelClicked to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Deprecated:
Since version 1.21.1. This method is deprecated now
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
fireSaveClicked(mArguments?): sap.ca.ui.FileUpload
Fire event saveClicked to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Deprecated:
Since version 1.21.1. This method is deprecated now. The rename or delete event is enough and should be use to commit the action immediatly
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining
getEditMode(): boolean
Getter for property editMode. Property to allow toggling between edit and view screens.

Default value is false

Deprecated:
Since version 1.21.0. This method is deprecatd now. If you want to prevent edit you can use useEditControls property or the deleteEnabled, renameEnabed and uploadEnabled properties
Returns:
{boolean} the value of property editMode
getShowAttachmentsLabelInEditMode(): boolean
Getter for property showAttachmentsLabelInEditMode. Show the Attachments label in edit mode

Default value is true

Deprecated:
Since version 1.21.0. This method is deprecated now. Use the showAttachmentsLabel instead
Returns:
{boolean} the value of property showAttachmentsLabelInEditMode
setAttachmentNumberLabel(oAttachmentNumberLabel): sap.ca.ui.FileUpload
Setter for the aggregated attachmentNumberLabel.
Parameters:
{sap.m.Label}oAttachmentNumberLabel
Deprecated:
Since version 1.21.0. This aggregation is deprecatd now. The label is part of the ToolBar
Returns:
{sap.ca.ui.FileUpload}this to allow method chaining