• Loading...
The following tables list the members exposed by Zip.

Public Constructors

NameDescription
Public ConstructorsZip ConstructorOverloaded. Creates new instance of the Zip class and initializes its members with default values.
Top

Public Properties

NameDescription
Public PropertiesCommentGets or sets the comment of the archive file.
Public PropertiesCompressionLevelGets or sets the compression level used for adding files to the archive. Default value is Medium.
Public PropertiesCompressionMethodGets or sets the compression algorithm used to compress archive items. Default value is CompressionMethod.Deflate.
Public PropertiesCompressionModeGets or sets the compression level used for adding files to the archive. Available values are from 0 to 9. 0 for no compression - storing files only. 9 for maximum compression rate. Default value is 6.
Public PropertiesCurrentVolumeFileNameGets the current volume file name of a spanning/splitting archive.
Public PropertiesCurrentVolumeNumberGets the current volume number of a spanning/splitting archive.
Public PropertiesDirectorySeparatorsGets an array containing the characters that are directory separators. (Inherited from ArchiverBase)
Public PropertiesEncryptionAlgorithmGets or sets the algorithm to use to encrypt archive items.
Public PropertiesExtractCorruptedFilesGets or sets a boolean value indicating whether the partially corrupted files can be extracted from damaged archive. Default value is false.
Public PropertiesFileNameGets the archive file name. (Inherited from ArchiverBase)
Public PropertiesFlushBuffersGets or sets the boolean value indicating whether to flush file buffers after any file modification and after extracting file from archive. (Inherited from ArchiverBase)
Public PropertiesInUpdateGets a boolean value indicating if an archive file is being updated. (Inherited from ArchiverBase)
Public PropertiesInvalidPathCharsGets an array containing the characters that are not allowed in path names. (Inherited from ArchiverBase)
Public PropertiesOemCodePageGets the number of the OEM code page used to store and restore archive. (Inherited from ArchiverBase)
Public PropertiesOpenCorruptedArchivesGets or sets a boolean value indicating whether the corrupted archives can be opened. Default value is true.
Public PropertiesOpenedGets a boolean value indicating whether an archive file is opened. (Inherited from ArchiverBase)
Public PropertiesPasswordGets or sets the password for encrypting files within the archive.
Public PropertiesPathStoringModeGets or sets the path storing mode. It defines how path information will be stored for files and directories within the archive . (Inherited from ArchiverBase)
Public PropertiesSfxStubFileNameGets or sets the file name of the executable stub.
Public PropertiesShareModeGets or sets the FileShare indicating the files being added to the archive will be opened for simultaneous access. The default value is FileShare.ReadWrite. (Inherited from ArchiverBase)
Public PropertiesSizeGets the size in bytes of the opened archive file. (Inherited from ArchiverBase)
Public PropertiesSpanningModeGets the spanning mode describling how the archive file will be stored on disk.
Public PropertiesStoreFileTimeGets or sets a boolean value indicating whether to save NTFS Extra Field containing file modification, last access and creation time of source file. Default value is true.
Public PropertiesStoreUnicodeNameGets or sets a boolean value indicating whether unicode file names are saved in addition to filenames in standard OEM encoding.
Public PropertiesVolumeSettingsGets the VolumeSettings object which specifies how the archive will be splitted or spanned.
Public PropertiesZip64ModeGets or sets the Zip64 mode indicating whether to use Zip64 format to create archives over 4GB and file added to the archive can be greater than 4GB.
Top

Protected Properties

NameDescription
Protected PropertiesCanGetStreamForReadingReturns a field indicating whether the system support getting stream for reading data from file. For internal uses only. (Inherited from ArchiverBase)
Protected PropertiesCanGetStreamForWritingReturns a field indicating whether the system support getting stream for writting data to file. For internal uses only. (Inherited from ArchiverBase)
Top

Public Methods

NameDescription
Public MethodsAddDirectoryAdds an entire directory or a file from the disk file system to the current working directory within the archive. (Inherited from ArchiverBase)
Public MethodsAddFileAdds data stored in the specified buffer to the archive file. (Inherited from ArchiverBase)
Public MethodsAddFileAsyncAsynchronously adds a file to the archive. File path within the archive will be determined by the PathStoringMode property. (Inherited from ArchiverBase)
Public MethodsAddFileFromStringAdds string to the archive. (Inherited from ArchiverBase)
Public MethodsAddFilesAdds files from the specified source directory on the specified source file system to the specified directory within the archive. (Inherited from ArchiverBase)
Public MethodsAddFilesAsyncAsynchronous adds files from the specified source directory on the specified source file system to the specified directory within the archive. (Inherited from ArchiverBase)
Public MethodsBeginUpdateBegins a transaction. (Inherited from ArchiverBase)
Public MethodsCancelCancels the current operation. (Inherited from ArchiverBase)
Public MethodsCancelUpdateCancels all transactions. Rollback current transaction started by the BeginUpdate method. CancelUpdate clears all archive modifications made after calling BeginUpdate. CancelUpdate sets InUpdate property to false. (Inherited from ArchiverBase)
Public MethodsCloseOverridden. Closes the archive.
Public MethodsCloseAsyncAsynchronously closes the archive. (Inherited from ArchiverBase)
Public MethodsCreateCreates a new archive file with the specified name. If the archive file already exists, it will be overwritten. (Inherited from ArchiverBase)
Public MethodsCreateDirectoryCreates a new directory in the archive. (Inherited from ArchiverBase)
Public MethodsCreateFileInfoCreates a new instance of the ArchiveItem class and set appropriate file information. (Inherited from ArchiverBase)
Public MethodsCreateSfxCreates a self-extracting (SFX) archive.
Public MethodsDeleteAllDeletes all files and directories within the archive. (Inherited from ArchiverBase)
Public MethodsDeleteDirectoryDeletes an empty directory. (Inherited from ArchiverBase)
Public MethodsDeleteFileDeletes a single file. (Inherited from ArchiverBase)
Public MethodsDirectoryExistsDetermines whether the given path refers to an existing directory. (Inherited from ArchiverBase)
Public MethodsEndUpdateEnds the current transaction initiated by a call to the BeginUpdate method. (Inherited from ArchiverBase)
Public MethodsExtractAllExtracts all files and directories within the archive. (Inherited from ArchiverBase)
Public MethodsExtractAllAsyncAsynchronously extracts all files and directories within the archive. (Inherited from ArchiverBase)
Public MethodsExtractFileExtracts the specified file to the specified destination file on the local disk. (Inherited from ArchiverBase)
Public MethodsExtractFileAsyncAsynchronously extracts a file stored withing the archive to a Stream object descendant. (Inherited from ArchiverBase)
Public MethodsExtractFileToStringExtracts a file stored withing the archive into a string. (Inherited from ArchiverBase)
Public MethodsExtractFilesExtracts files from the specified directory within the archive to the destination directory on the destination file system. (Inherited from ArchiverBase)
Public MethodsExtractFilesAsyncAsynchronously extracts files from the specified directory within the archive that match the search condition specified in the option parameter to the destination directory on the destination file system. (Inherited from ArchiverBase)
Public MethodsFileExistsDetermines whether the given file path refers to an existing file. (Inherited from ArchiverBase)
Public MethodsGetCurrentDirectoryGets the current working directory in the archive. (Inherited from ArchiverBase)
Public MethodsGetFileCountReturns the number of files in the archive file. (Inherited from ArchiverBase)
Public MethodsGetFileLengthGets the file length in bytes. (Inherited from ArchiverBase)
Public MethodsGetItemInfoGets the file information. (Inherited from ArchiverBase)
Public MethodsGetLastWriteTimeGets the date and time when archive item was last written to (last modified time). (Inherited from ArchiverBase)
Public MethodsGetSupportedChecksumTypesReturns the supported checksum types. (Inherited from ArchiverBase)
Public MethodsIsValidArchiveFileReturns a boolean value indicating whether the opened archive is valid.
Public MethodsListAllOverloaded. Overridden. Lists files and subdirectories within the archive that match the specified search condition.
Public MethodsOpenOverloaded. Overridden. Opens or creates an archive within a stream.
Public MethodsRenameRenames an existing file within the archive. (Inherited from ArchiverBase)
Public MethodsRepairOverloaded. Repairs the specified archive and save to the same file.
Public MethodsSetAttributesUpdates attributes of the specified file. An exception is thrown if the specified file does not exist. (Inherited from ArchiverBase)
Public MethodsSetCurrentDirectorySets the current working directory in the archive. (Inherited from ArchiverBase)
Public MethodsSetFileCommentOverloaded. Updates comment of the specified file. An exception is thrown if the specified file does not exist.
Public MethodsSetLastWriteTimeSets the date and time that the specified file was last written to. (Inherited from ArchiverBase)
Public MethodsSetMultipleFilesAttributesUpdates attributes of multiple files. (Inherited from ArchiverBase)
Public MethodsSetMultipleFilesCommentOverloaded. Updates comments of multiple files.
Public MethodsTestAllFilesTests all files within the archive. (Inherited from ArchiverBase)
Public MethodsTestFileTests the specified file. It throws an exception if errors found. (Inherited from ArchiverBase)
Public MethodsTestPasswordReturns a boolean value indicating whether the password is valid for specified encrypted file in archive.
Public MethodsToStringOverridden. Returns a string that represents the current archive.
Top

Protected Methods

NameDescription
Protected MethodsDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ArchiverBase)
Protected MethodsEndUpdateEnds the current transaction. (Inherited from ArchiverBase)
Protected MethodsOnAddFileCompletedRaises the AddFileCompleted event. (Inherited from ArchiverBase)
Protected MethodsOnAddFilesCompletedRaises the AddFilesCompleted event. (Inherited from ArchiverBase)
Virtual Protected MethodsOnBlankVolumeRequestedRaises the BlankVolumeRequested event.
Protected MethodsOnCloseCompletedRaises the CloseCompleted event. (Inherited from ArchiverBase)
Virtual Protected MethodsOnDiskFullRaises the DiskFull event.
Virtual Protected MethodsOnExistingVolumeRequestedRaises the ExistingVolumeRequested event.
Protected MethodsOnExtractAllCompletedRaises the ExtractAllCompleted event. (Inherited from ArchiverBase)
Protected MethodsOnExtractFileCompletedRaises the ExtractFileCompleted event. (Inherited from ArchiverBase)
Protected MethodsOnExtractFilesCompletedRaises the ExtractFilesCompleted event. (Inherited from ArchiverBase)
Virtual Protected MethodsOnPasswordNeededRaises the PasswordNeeded event.
Protected MethodsOnProgressRaises the Progress event. (Inherited from ArchiverBase)
Top

Public Events

NameDescription
Public EventsAddFileCompletedOccurs when an asynchronous AddFileAsync operation completes. (Inherited from ArchiverBase)
Public EventsAddFilesCompletedOccurs when an asynchronous AddFilesAsync operation completes. (Inherited from ArchiverBase)
Public EventsBlankVolumeRequestedOccurs when next volume should be inserted while writing a multi-volume archive.
Public EventsCloseCompletedOccurs when an asynchronous CloseAsync operation completes. (Inherited from ArchiverBase)
Public EventsDiskFullOccurs when disk is full.
Public EventsExistingVolumeRequestedOccurs when a volume should be inserted while extracting or testing a multi-volume archive.
Public EventsExtractAllCompletedOccurs when an asynchronous ExtractAllAsync operation completes. (Inherited from ArchiverBase)
Public EventsExtractFileCompletedOccurs when an asynchronous ExtractFileAsync operation completes. (Inherited from ArchiverBase)
Public EventsExtractFilesCompletedOccurs when an asynchronous ExtractFilesAsync operation completes. (Inherited from ArchiverBase)
Public EventsPasswordNeededOccurs when a password for the encrypted file is needed.
Public EventsSaveProgressOccurs when the archive or archive item is being saved to the disk. (Inherited from ArchiverBase)
Top

See Also