IPWorks ZIP 2020 ActiveX Edition

Questions / Feedback?

Zip Control

Properties   Methods   Events   Configuration Settings   Errors  

The Zip control implements a PKZip-compatible Zip compressor and decompressor.




The control uses the Deflate algorithm specified in RFC 1951 for compression, and produces and reads output compatible with PKZip, WinZip, etc.

To create a new archive, first set the ArchiveFile property to the name of the archive to be created. Then, specify the files to be compressed either by invoking IncludeFiles, or by adding a new object to the Files collection and setting the values of the FileDecompressedName and FileCompressedName. fields. Finally, call the Compress method to create the archive.

To decompress an existing archive, set ArchiveFile to the name of the archive to be decompressed. The ExtractToPath property may be set, and then calling the ExtractAll method will decompress all files in the archive to this path.

For finer control, the Scan method should be used to read the file information stored in the archive. This will fill out the information in the Files collection. The values of FileDecompressedName may then be changed if desired. Finally, ExtractAll may be used to decompress the entire archive, or Extract may be used for finer control.

Data may be streamed out by setting WriteToProgressEvent to true. Then, the Progress event may be trapped to retrieve the data.

Example (Creating an Archive)

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

Example (Extracting from an Archive)

ZipControl.ArchiveFile = "c:\temp.zip"
ZipControl.ExtractToPath = "c:\extracted\"

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

ArchiveFileThe name of the zip, gzip, tar, or jar archive.
CompressionLevelThe compression level to use.
CompressionMethodThe compression method to use.
EncryptionAlgorithmThe algorithm used to encrypt files written to the archive.
ExcludedFilesA list of files to exclude.
ExtractToPathA base path to decompress to.
FileCountThe number of records in the File arrays.
FileAttributesThe attributes of the files to be compressed or decompressed.
FileCommentSpecifies a comment for the entry in the zip file.
FileCompressedDateThe date and time of the entry, as stored within the archive.
FileCompressedNameThe file name of the current file, as stored inside of the archive.
FileCompressedSizeThe size of the compressed data, as compressed within the archive.
FileCompressionLevelThe compression level to use for the file.
FileCRCThe CRC value for the specified file found in the archive.
FileDecompressedNameThe name of the file in the archive, as stored on the file system, outside the archive.
FileDecompressedSizeThe size of the file, as decompressed outside the archive.
FileEncryptionAlgorithmThe algorithm used to encrypt the specified file written to the archive.
FileHashThe computed hash for the specified File.
FileInputDataWhen This property is set, the control will read in the data from This property instead of reading from the file contained in the DecompressedName property.
FilePasswordThis property specifies the case-sensitive password used to encrypt or decrypt the current file.
FilePasswordRequiredThis property describes whether or not the current file has been encrypted or not and requires a password to decompress.
OverwriteFilesWhether or not to overwrite files.
PasswordA password for the zip archive.
RecurseSubdirectoriesWhether or not to recurse into subdirectories.
ZipCommentThe comment for the entire zip file.
ZipData(Decompression only) The zip file contents as a byte array.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

AbortAborts the current operation.
AppendFilesAdds specified files to an existing archive.
CompressCreates the compressed archive.
ConfigSets or retrieves a configuration setting.
DeleteDeletes one or more files from an existing archive.
ExtractExtracts a single file, directory, or group of files, from the archive.
ExtractAllExtracts all files from the compressed archive.
IncludeFilesSpecifies that the indicated files should be added to the archive.
ResetResets the control.
ScanScans the compressed archive.
UpdateWill update certain files in an archive.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

BeginFileFired before each file is processed.
EndFileFired after each file is processed.
ErrorInformation about non-fatal errors.
OverwriteFired whenever a file exists and may be overwritten.
PasswordFired when a file is encrypted, and the file's password is incorrect.
ProgressFired as progress is made.

Configuration Settings

The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.

AESGenerateUniqueKeysWhether to generate unique keys for each file encrypted.
CheckForFileLocksIf true, the control requests an exclusive lock during initialization.
CompressionMethodUsed to set the method of compression.
EnableStreamingEncryptionWhether to allow streaming and encryption simultaneously.
ExcludedAttributesAttributes of files to be excluded.
ExtractFilesOnlyWhether to only extract the files contained within the archive.
FileHashAlgorithmThe algorithm to use when computing the file hash.
ForceZip64FormatWhether to explicitly compress a Zip64 format archive.
MarkAsTextWhether to mark files as text files.
OverwriteReadonlyFilesWhether to overwrite readonly files.
PreserveModifiedTimeWhether or not to preserve the original modified time on extracted files.
RecalculateCRCWhether to recalculate the CRC.
VerifyPasswordCheck whether the specified Password can decrypt the archive without extracting files.
WriteToProgressEventWhether or not to write data to the Progress Event.
CodePageThe system code page used for Unicode to Multibyte translations.
UseInternalSecurityAPITells the control whether or not to use the system security libraries or an internal implementation.

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