Compress Method

Creates the compressed archive.


public void Compress();
Public Sub Compress()


Invoking Compress creates the archive specified by ArchiveFile. When the method is called, all files specified by the DecompressedName field of the Files collection will be compressed and written to ArchiveFile.

The compressed data may be streamed out by setting WriteToProgressEvent to true. If streaming is enabled the compressed data will also be provided via the Progress event. If ArchiveFile is set to an empty string the archive will be written only to this event.

The files to compress are specified in the Files collection. The file names are specified by CompressedName and DecompressedName. These should be specified before invoking Compress, either manually or by invoking IncludeFiles.

The BeginFile and EndFile events will be fired as files are processed, and the Progress event will be fired as data is compressed.

Existing files will be overwritten by the component if OverwriteFiles is set to true. Finer control over which files are overwritten may be gained by trapping the Overwrite event.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\"
ZipControl.RecurseSubdirectories = true

.NET Standard Notes

To call this method in an asynchronous manner call CompressAsync instead. When the method completes (or an error is encountered) the CompressCompleted event will fire.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks ZIP 2020 .NET Edition - Version 20.0 [Build 7720]