ASPxHtmlEditor.DocumentSelectorFileUploading Event
Fires before a file is uploaded to the Document Selector and allows you to cancel the action.
Namespace: DevExpress.Web.ASPxHtmlEditor
Assembly: DevExpress.Web.ASPxHtmlEditor.v24.1.dll
NuGet Package: DevExpress.Web
Declaration
Event Data
The DocumentSelectorFileUploading event's data class is FileManagerFileUploadEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Cancel | Gets or sets a value indicating whether the action that raised the event should be canceled. Inherited from FileManagerActionEventArgsBase. |
| ErrorText | Gets or sets a text for the explanatory message. Inherited from FileManagerActionEventArgsBase. |
| File | Gets a file, related to the event. |
| FileName | Gets or sets the name of a file selected to upload. |
| InputStream | Gets a stream object that points to the uploaded file. |
| OutputStream | Gets a stream object that points to the uploaded file. |
Remarks
Prior to each time a file is uploaded to the Document Selector, the DocumentSelectorFileUploading event occurs, allowing you to cancel the file upload. The event parameter’s FileManagerFileUploadEventArgs.File property identifies the file that is being processed. The FileManagerFileUploadEventArgs.InputStream and FileManagerFileUploadEventArgs.OutputStream properties allow you to modify a file, before sending it to the server side. The FileManagerFileUploadEventArgs.FileName property allows you specify a custom name for the file.
To cancel the upload operation, set the FileManagerActionEventArgsBase.Cancel property to true. To show a message explaining the reason for the upload cancellation, specify the FileManagerActionEventArgsBase.ErrorText property.
To customize the Document Selector settings use the HtmlEditorInsertLinkDialogSettings.SettingsDocumentSelector property.