ZipArchive.AddFile(String) Method

Creates a zip file item for the specified file and adds it to the archive.

Namespace: DevExpress.Compression

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public ZipFileItem AddFile(
    string fileName
)

VB.NET

Public Function AddFile(
    fileName As String
) As ZipFileItem

Parameters

Name	Type	Description
fileName	String	A string that is the path to the file.

Returns

Type	Description
ZipFileItem	A ZipFileItem that is the file item in the archive.

Remarks

This method adds the specified file to the archive. The path in the archive is constructed the following way:

• For rooted paths - the path is the path to the root;
• For other paths - the path is relative to the file path.

For example, the file “C:\Temp\AAA\BBB\winnipooh.txt” is added to the archive as a ZipFileItem with the ZipItem.Name property set to “Temp/AAA/BBB/winnipooh.txt” (archive path) and a ZipFileItem.FileName property set to “C:\Temp\AAA\BBB\winnipooh.txt” (file path).

This code snippet demonstrates how to create a new archive and add files with .txt and .docx extensions to the archive root. The ZipArchive.Save method compresses data and saves the archive to a file.

View Example

ZipExamples.cs

using DevExpress.Compression;

public void ArchiveFiles() {
    string[] sourcefiles = this.sourceFiles;
    string[] ext = new string[] {".txt", ".docx"};
    using (ZipArchive archive = new ZipArchive()) {
        foreach (string file in sourcefiles) {
            if (ext.Contains(Path.GetExtension(file)))
            archive.AddFile(file, "/");
        }
        archive.Save("Documents\\ArchiveFiles.zip");
    }
}

ZipExamples.vb

Imports DevExpress.Compression

Public Sub ArchiveFiles()
    Dim sourcefiles() As String = Me.sourceFiles
    Dim ext() As String = {".txt", ".docx"}
    Using archive As New ZipArchive()
        For Each file As String In sourcefiles
            If ext.Contains(Path.GetExtension(file)) Then
            archive.AddFile(file, "/")
            End If
        Next file
        archive.Save("Documents\ArchiveFiles.zip")
    End Using
End Sub