ASPxHtmlEditor.DocumentSelectorItemRenaming Event

Fires before an item is renamed within the Document Selector, and allows you to cancel the action.

Namespace: DevExpress.Web.ASPxHtmlEditor

Assembly: DevExpress.Web.ASPxHtmlEditor.v19.2.dll

Declaration

public event FileManagerItemRenameEventHandler DocumentSelectorItemRenaming
Public Event DocumentSelectorItemRenaming As FileManagerItemRenameEventHandler

Event Data

The DocumentSelectorItemRenaming event handler receives an argument of the FileManagerItemRenameEventArgs type. 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.
ErrorText Gets or sets a text for the explanatory message.
Item Gets an item object related to the event.
NewName Gets a new name for the item currently being renamed.

Remarks

Each time an item is going to be renamed within the Document Selector, the DocumentSelectorItemRenaming event occurs, allowing you to cancel the action. The event parameter's FileManagerItemRenameEventArgs.Item property identifies the item that is being processed. The new name of the item can be obtained via the FileManagerItemRenameEventArgs.NewName property. To cancel the renaming operation, set the FileManagerActionEventArgsBase.Cancel property to true. To show a message explaining the reason for canceling the renaming operation, specify the FileManagerActionEventArgsBase.ErrorText property.

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

See Also