Skip to main content

ASPxHtmlEditor.DocumentSelectorItemCopying Event

Fires before an item is copied within 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

public event FileManagerItemCopyEventHandler DocumentSelectorItemCopying

Event Data

The DocumentSelectorItemCopying event's data class is FileManagerItemCopyEventArgs. 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.
DestinationFolder Gets a folder where the current item is being copied.
ErrorText Gets or sets a text for the explanatory message. Inherited from FileManagerActionEventArgsBase.
Item Gets an item object related to the event.

Remarks

Each time an item is going to be copied within the Document Selector, the DocumentSelectorItemCopying event occurs, allowing you to cancel the action. The event parameter’s FileManagerItemCopyEventArgs.Item property identifies the item that is being processed. The new location of an item can be obtained by the FileManagerItemCopyEventArgs.DestinationFolder property. To cancel the copy operation, set the FileManagerActionEventArgsBase.Cancel property to true. To show a message explaining the reason for canceling the copy operation, specify the FileManagerActionEventArgsBase.ErrorText property.

To customize the Document Selector settings use the HtmlEditorInsertLinkDialogSettings.SettingsDocumentSelector property.

See Also