ZipItemAddingEventArgs.Action Property

Gets or sets the action required to perform after the ItemAdding event is handled.

Namespace: DevExpress.Compression

Assembly: DevExpress.Docs.v20.2.dll

NuGet Package: DevExpress.Document.Processor

NuGet Packages: DevExpress.Document.Processor, DevExpress.WindowsDesktop.Document.Processor

Declaration

C#

public ZipItemAddingAction Action { get; set; }

VB.NET

Public Property Action As ZipItemAddingAction

Property Value

Type	Description
ZipItemAddingAction	A ZipItemAddingAction enumeration value specifying which action to perform.

Available values:

Name	Description
Continue	Add the current item to the archive and move to the next item. Default value.
Stop	Stops adding items to archive.
Cancel	Cancel adding a current item to the archive and skip to the next item.

Remarks

You can handle the ZipArchive.ItemAdding event and decide whether to skip the current item and not add it to the archive, or to cancel the entire archiving process.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Action 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#

zip-compression-and-archive-api-examples/CS/CompressionLibraryExamples/ZipExamples.cs#L97

if (args.Item.CreationTime.Date != DateTime.Today)
    args.Action = ZipItemAddingAction.Cancel;
if (stopArchiving) args.Action = ZipItemAddingAction.Stop;

VB.NET

zip-compression-and-archive-api-examples/VB/CompressionLibraryExamples/ZipExamples.vb#L97

If args.Item.CreationTime.Date <> DateTime.Today Then
    args.Action = ZipItemAddingAction.Cancel
End If