ZipItem.Extract(String, AllowFileOverwriteMode) Method

Extracts the current archive item as a file into the specified directory and enables you to define the behavior in case of a file name conflict.

Namespace: DevExpress.Compression

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void Extract(
    string directory,
    AllowFileOverwriteMode allowFileOverwrite
)

VB.NET

Public Sub Extract(
    directory As String,
    allowFileOverwrite As AllowFileOverwriteMode
)

Parameters

Name	Type	Description
directory	String	A string that is the path to the directory to which the files are extracted.
allowFileOverwrite	AllowFileOverwriteMode	An AllowFileOverwriteMode enumeration member that specifies the behavior if a file name conflict occurs.

Remarks

If the archive contains directories, the directory structure will be recreated in the specified directory. The ZipItem.Name property value becomes the file name of the extracted file. If a file with the same name already exists, a file name conflict occurs. In this situation, the AllowFileOverwriteMode parameter specifies the default action.

This example illustrates how to handle a file name conflict when files are extracted from archive. If a file with the same name exists, the ZipArchive.AllowFileOverwrite event occurs. You can handle this event and determine that if the file in the folder is newer than the zip item, the file in the folder should not be overwritten.

View Example

ZipExamples.cs

using DevExpress.Compression;

public void UnzipArchiveConflict() {
    string pathToZipArchive = "Documents\\Example.zip";
    string pathToExtract = "Documents\\!Extracted";
    using (ZipArchive archive = ZipArchive.Read(pathToZipArchive)) {
        archive.OptionsBehavior.AllowFileOverwrite = AllowFileOverwriteMode.Custom;
        archive.AllowFileOverwrite += archive_AllowFileOverwrite;
        foreach (ZipItem item in archive) {
            item.Extract(pathToExtract);
        }
    }
}

private void archive_AllowFileOverwrite(object sender, AllowFileOverwriteEventArgs e) {
    FileInfo fi = new FileInfo(e.TargetFilePath);
    if (e.ZipItem.LastWriteTime < fi.LastWriteTime) e.Cancel = true;
}

ZipExamples.vb

Imports DevExpress.Compression

Public Sub UnzipArchiveConflict()
    Dim pathToZipArchive As String = "Documents\Example.zip"
    Dim pathToExtract As String = "Documents\!Extracted"
    Using archive As ZipArchive = ZipArchive.Read(pathToZipArchive)
        archive.OptionsBehavior.AllowFileOverwrite = AllowFileOverwriteMode.Custom
        AddHandler archive.AllowFileOverwrite, AddressOf archive_AllowFileOverwrite
        For Each item As ZipItem In archive
            item.Extract(pathToExtract)
        Next item
    End Using
End Sub

Private Sub archive_AllowFileOverwrite(ByVal sender As Object, ByVal e As AllowFileOverwriteEventArgs)
    Dim fi As New FileInfo(e.TargetFilePath)
    If e.ZipItem.LastWriteTime < fi.LastWriteTime Then
        e.Cancel = True
    End If
End Sub