ZipArchiveOptionsBehavior.AllowFileOverwrite Property

Gets or sets the default behavior in case of a file conflict when extracting files from an archive.

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 AllowFileOverwriteMode AllowFileOverwrite { get; set; }

VB.NET

Public Property AllowFileOverwrite As AllowFileOverwriteMode

Property Value

Type	Description
AllowFileOverwriteMode	An AllowFileOverwriteMode enumeration value that specifies the default behavior.

Available values:

Name	Description
Custom	Fires the ZipArchive.AllowFileOverwrite event if a file name conflict occurs.
Allow	Allows overwriting files in the destination path without prompting.
Forbidden	If a file name conflict occurs, the unzipping process skips to the next zip item and the file in the destination path remains intact.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowFileOverwrite
ZipArchive	.OptionsBehavior .AllowFileOverwrite

Remarks

You can decide whether the file with the same name should be overwritten for each file individually by setting the AllowFileOverwrite to AllowFileOverwriteMode.Custom and handling the ZipArchive.AllowFileOverwrite event.

Related GitHub Examples

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

using (ZipArchive archive = ZipArchive.Read(pathToZipArchive)) {
    archive.OptionsBehavior.AllowFileOverwrite = AllowFileOverwriteMode.Custom;
    archive.AllowFileOverwrite += archive_AllowFileOverwrite;

VB.NET

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

Using archive As ZipArchive = ZipArchive.Read(pathToZipArchive)
    archive.OptionsBehavior.AllowFileOverwrite = AllowFileOverwriteMode.Custom
    AddHandler archive.AllowFileOverwrite, AddressOf archive_AllowFileOverwrite