FileManagerActionEventArgsBase.Cancel Property

Gets or sets a value indicating whether the action that raised the event should be canceled.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

C#

public bool Cancel { get; set; }

VB.NET

Public Property Cancel As Boolean

Property Value

Type	Description
Boolean	true if the action that raised the event should be canceled; otherwise, false.

Remarks

The FileManagerActionEventArgsBase object is passed to the events that fire before specific actions. The Cancel property of this object enables you to cancel the action that is about to be performed. Set this property to true to cancel the action that raised the event. In this case, if the FileManagerActionEventArgsBase.ErrorText property is specified, the explanatory message is shown.

Example

The code below demonstrates how you can handle the FolderCreating event, to prevent creation of child folders for the root folder.

The image below shows the result.

C#

protected void ASPxFileManager1_FolderCreating(object source, DevExpress.Web.FileManagerFolderCreateEventArgs e) {
      if (e.ParentFolder.FullName == "Files")
            e.Cancel = true;
            e.ErrorText = "You cannot create child folders for the root folder";
}

ASPX

<dx:ASPxFileManager ID="ASPxFileManager1" runat="server" OnFolderCreating="ASPxFileManager1_FolderCreating">
            <Settings RootFolder="~/Content/FileManager/Files" ThumbnailFolder="~\Thumb" />
            <SettingsEditing AllowCreate="True" />
</dx:ASPxFileManager>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Cancel property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxfilemanager-how-to-implement-a-list-data-bound-custom-file-system-provider-e5024/CS/WebApplication2/Default.aspx.cs#L38

// comment out this line to enable editing
e.Cancel = true;
e.ErrorText = "Data modifications are not allowed in the example.";

VB.NET

aspxfilemanager-how-to-implement-a-list-data-bound-custom-file-system-provider-e5024/VB/WebApplication2/Default.aspx.vb#L40

' comment out this line to enable editing
e.Cancel = True
e.ErrorText = "Data modifications are not allowed in the example."