The ZipArchive type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
  | ZipArchive(Stream) |
Initializes a ZipArchive object with the specified ZIP archive stream.
|
| ZipArchive(String) |
Initializes a ZipArchive object with the specified ZIP archive.
|
| ZipArchive(Stream, ArchiveStreamCloseMode) |
Initializes a ZipArchive object with the specified ZIP archive stream.
|
| ZipArchive(Stream, Boolean) | Obsolete. |
| ZipArchive(String, ArchiveOpenMode) |
Initializes a ZipArchive object with the specified ZIP archive.
|
| ZipArchive(String, ArchiveOpenMode, ArchiveAccessMode) |
Initializes a ZipArchive object with the specified ZIP file.
|
Methods
| Name | Description | |
|---|---|---|
| Add(String) |
Adds specified local files or directories to the ZIP archive.
|
| Add(FileSet) | Obsolete. |
| Add(FileSet) |
Adds specified local files or directories to the ZIP archive.
|
| Add(String, String) |
Adds specified local files or directories to a directory within the ZIP archive.
|
| Add(FileSet, String) | Obsolete. |
| Add(FileSet, String) |
Adds specified local files or directories to a directory within the ZIP archive.
|
| Add(String, String, TraversalMode) |
Adds specified local files or directories to a directory within the ZIP archive.
|
 | Add(String, String, String) |
Adds specified local files or directories to a directory within the specified ZIP archive.
|
| Add(FileSet, String, ArchiveActionOnExistingFile) | Obsolete. |
| Add(String, String, ArchiveTraversalMode, ArchiveActionOnExistingFile) | Obsolete. |
| Add(FileSet, String, TransferMethod, ActionOnExistingFiles) |
Adds specified local files or directories to a directory within the ZIP archive.
|
| Add(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Adds specified local files or directories to a directory within the ZIP archive.
|
| Add(String, String, String, ArchiveTraversalMode, ArchiveActionOnExistingFile) | Obsolete. |
| Add(String, String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Adds specified local files or directories to a directory within the specified ZIP archive.
|
| AddAsync(FileSet, String, ArchiveActionOnExistingFile) | Obsolete. |
| AddAsync(String, String, ArchiveTraversalMode, ArchiveActionOnExistingFile) | Obsolete. |
| AddAsync(FileSet, String, TransferMethod, ActionOnExistingFiles) |
Begins asynchronous Add operation.
Adds specified local files or directories to a directory within the ZIP archive.
|
| AddAsync(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Begins asynchronous Add operation.
Adds specified local files or directories to a directory within the ZIP archive.
|
| AddFile(String) |
Adds the specified file to the root directory of the ZIP archive.
|
| AddFile(Stream, String) |
Adds data from the specified stream to the ZIP archive.
|
| AddFile(String, String) |
Adds the specified local file to the specified directory within the ZIP archive.
|
| AddFile(Stream, String, ActionOnExistingFiles) |
Adds data from the specified stream to the ZIP archive.
|
| AddFile(String, String, ActionOnExistingFiles) |
Adds the specified local file to the specified directory within the ZIP archive.
|
| AddFileAsync(Stream, String) |
Begins asynchronous AddFile operation.
Adds data from the specified stream to the ZIP archive.
|
| AddFileAsync(String, String) |
Begins asynchronous AddFile operation.
Adds the specified local file to the specified directory within the ZIP archive.
|
| AddFileAsync(Stream, String, ActionOnExistingFiles) |
Begins asynchronous AddFile operation.
Adds data from the specified stream to the ZIP archive.
|
| AddFileAsync(String, String, ActionOnExistingFiles) |
Begins asynchronous AddFile operation.
Adds the specified local file to the specified directory within the ZIP archive.
|
| Cancel |
Requests the currently processing operation to be canceled as soon as possible.
|
| Close()()()() |
Closes the current ZipArchive object and releases any resources associated with it (file or stream).
This is the same as calling Close(ArchiveSaveAction) with Auto argument.
|
| Close(ArchiveSaveAction) |
Closes the current ZipArchive object and releases any resources associated with it (file or stream).
|
| CreateDirectory(String) |
Creates a directory within the ZIP archive.
|
| CreateDirectory(String, String) |
Creates new empty directory within the specified ZIP archive.
|
| Decrypt |
Decrypts an existing ZIP archive to the specified zip archive.
|
| Delete(String) |
Deletes files and/or empty directories within the ZIP archive.
|
| Delete(FileSet) | Obsolete. |
| Delete(FileSet) |
Deletes files and/or directories within the ZIP archive.
|
| Delete(String, ArchiveSaveAction) | Obsolete. |
| Delete(String, ArchiveTraversalMode) | Obsolete. |
| Delete(String, TraversalMode) |
Deletes files and/or directories within the ZIP archive.
|
| Delete(String, String) |
Deletes files and/or empty directories from the specified ZIP archive.
|
| Delete(FileSet, ArchiveSaveAction) | Obsolete. |
| Delete(FileSet, ArchiveSaveAction) |
Deletes files and/or directories within the ZIP archive.
|
| Delete(String, ArchiveTraversalMode, ArchiveSaveAction) | Obsolete. |
| Delete(String, TraversalMode, ArchiveSaveAction) |
Deletes files and/or directories within the ZIP archive.
|
| Delete(String, String, ArchiveSaveAction) |
Deletes files and/or empty directories from the specified ZIP archive.
|
| Delete(String, String, ArchiveTraversalMode) | Obsolete. |
| Delete(String, String, TraversalMode) |
Deletes files and/or directories from the specified ZIP archive.
|
| Delete(String, String, ArchiveTraversalMode, ArchiveSaveAction) | Obsolete. |
| Delete(String, String, TraversalMode, ArchiveSaveAction) |
Deletes files and/or directories from the specified ZIP archive.
|
| DeleteAsync(FileSet, ArchiveSaveAction) | Obsolete. |
| DeleteAsync(FileSet, ArchiveSaveAction) |
Begins asynchronous Delete operation.
Deletes files and/or directories within the ZIP archive.
|
| DeleteAsync(String, ArchiveTraversalMode, ArchiveSaveAction) | Obsolete. |
| DeleteAsync(String, TraversalMode, ArchiveSaveAction) |
Begins asynchronous Delete operation.
Deletes files and/or directories within the ZIP archive.
|
| DeleteFile(String) |
Deletes a file within the ZIP archive.
|
| DeleteFile(String, ArchiveSaveAction) |
Deletes a file within the ZIP archive.
|
| DeleteFileAsync |
Begins asynchronous DeleteFile operation.
Deletes a file within the ZIP archive.
|
| DirectoryExists |
Gets a value indicating whether the specified directory is present in the ZIP archive.
|
 | Dispose |
Releases the unmanaged resources used by the ZipArchive and optionally releases the managed resources.
|
| Encrypt |
Encrypts an existing ZIP archive to the specified file.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Extract(String, String) |
Extracts specified archive item(s) into the specified local directory.
|
| Extract(FileSet, String) | Obsolete. |
| Extract(FileSet, String) |
Extracts specified archive item(s) into the specified local directory.
|
| Extract(String, String, TraversalMode) |
Extracts specified archive item(s) into the specified local directory.
|
| Extract(String, String, String) |
Extracts specified archive item(s) from the specified ZIP archive into the specified local directory.
|
| Extract(FileSet, String, ArchiveActionOnExistingFile) | Obsolete. |
| Extract(String, String, ArchiveTraversalMode, ArchiveActionOnExistingFile) | Obsolete. |
| Extract(FileSet, String, TransferMethod, ActionOnExistingFiles) |
Extracts specified archive item(s) into the specified local directory.
|
| Extract(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Extracts specified archive item(s) into the specified local directory.
|
| Extract(String, String, String, ArchiveTraversalMode, ArchiveActionOnExistingFile) | Obsolete. |
| Extract(String, String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Extracts specified archive item(s) from the specified ZIP archive into the specified local directory.
|
| ExtractAll(String) |
Extracts the whole content of the ZIP archive into the specified local directory.
|
| ExtractAll(String, ActionOnExistingFiles) |
Extracts the whole content of the ZIP archive into the specified local directory.
|
| ExtractAll(String, ArchiveActionOnExistingFile) | Obsolete. |
| ExtractAll(String, String) |
Extracts the whole content of the specified ZIP archive into the specified local directory.
|
| ExtractAll(String, TransferMethod, ActionOnExistingFiles) |
Extracts the whole content of the ZIP archive into the specified local directory.
|
| ExtractAll(String, String, ArchiveActionOnExistingFile) | Obsolete. |
| ExtractAll(String, String, TransferMethod, ActionOnExistingFiles) |
Extracts the whole content of the specified ZIP archive into the specified local directory.
|
| ExtractAsync(FileSet, String, ArchiveActionOnExistingFile) | Obsolete. |
| ExtractAsync(String, String, ArchiveTraversalMode, ArchiveActionOnExistingFile) | Obsolete. |
| ExtractAsync(FileSet, String, TransferMethod, ActionOnExistingFiles) |
Begins asynchronous Extract operation.
Extracts specified archive item(s) into the specified local directory.
|
| ExtractAsync(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles) |
Begins asynchronous Extract operation.
Extracts specified archive item(s) into the specified local directory.
|
| ExtractFile(String, Stream) |
Extracts the specified archive file item into a stream.
|
| ExtractFile(String, String) |
Extracts the specified archive file item into a local file.
|
| ExtractFile(String, String, ActionOnExistingFiles) |
Extracts the specified archive file item into a local file.
|
| ExtractFileAsync(String, Stream) |
Begins asynchronous ExtractFile operation.
Extracts the specified archive file item into a stream.
|
| ExtractFileAsync(String, String) |
Begins asynchronous ExtractFile operation.
Extracts the specified archive file item into a local file.
|
| ExtractFileAsync(String, String, ActionOnExistingFiles) |
Begins asynchronous ExtractFile operation.
Extracts the specified archive file item into a local file.
|
| FileExists |
Gets a value indicating whether the specified file is present in the ZIP archive.
|
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
|
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetItem |
Gets the ZipItem object that represents the specified path.
|
| GetItems()()()() |
Gets the collection of all archive items stored within the ZIP archive.
|
| GetItems(FileSet) |
Gets the collection of archive items stored within the ZIP archive matching the specified set.
|
| GetItems(String, ArchiveTraversalMode) | Obsolete. |
| GetItems(String, TraversalMode) |
Gets the collection of archive items stored within the ZIP archive matching the specified path or mask using the specified traversal mode.
|
| GetItems(FileSet, ArchiveItemTypes) |
Gets the collection of archive items stored within the ZIP archive matching the specified set.
|
| GetItems(String, ArchiveTraversalMode, ArchiveItemTypes) | Obsolete. |
| GetItems(String, TraversalMode, ArchiveItemTypes) |
Gets the collection of archive items stored within the ZIP archive matching the specified path or mask and type using the specified traversal mode.
|
| GetItemsAsync()()()() |
Begins asynchronous GetItems operation.
Gets the collection of all archive items stored within the ZIP archive.
|
| GetItemsAsync(FileSet, ArchiveItemTypes) |
Begins asynchronous GetItems operation.
Gets the collection of archive items stored within the ZIP archive matching the specified set.
|
| GetItemsAsync(String, ArchiveTraversalMode, ArchiveItemTypes) | Obsolete. |
| GetItemsAsync(String, TraversalMode, ArchiveItemTypes) |
Begins asynchronous GetItems operation.
Gets the collection of archive items stored within the ZIP archive matching the specified path or mask and type using the specified traversal mode.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Move(String, String) |
Moves or renames an archive item (file or directory).
|
| Move(String, String, String) |
Moves (renames) an archive item (file or directory) within the specified ZIP archive.
|
| MoveAsync |
Begins asynchronous Move operation.
Moves or renames an archive item (file or directory).
|
| Save()()()() |
Saves pending changes into the ZIP archive and flushes the underlying stream.
|
| Save(ArchiveSaveAction) |
Saves pending changes into the ZIP archive and flushes the underlying stream.
|
| SaveAsync |
Begins asynchronous Save operation.
Saves pending changes into the ZIP archive and flushes the underlying stream.
|
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | Comment |
Gets or sets the comment for the whole ZIP archive.
|
| CompressionLevel |
Gets or sets the compression level to be used by Add(String) and AddFile(String) methods.
Possible values are 0-9, where 0 means no compression (fastest) and 9 means best compression (slowest).
6 (medium compression and speed) is a default value.
|
| CompressionMethod |
Gets or sets the compression method to be used by Add(String) and AddFile(String) methods.
|
| DefaultLogWriter |
Gets or sets a default log writer used by all new instances of ZipArchive object.
|
| EncryptionAlgorithm |
Gets or sets the encryption algorithm to be used by Add(String) and AddFile(String) methods.
|
| FilePath |
Gets an absolute path to the ZIP archive file or a null reference
(Nothing in Visual Basic) if the path is not available.
|
| ForceManagedAes | Obsolete. |
| IsBusy |
Gets a value indicating whether there is any asynchronous operation on the current object in progress.
|
| IsDisposed |
Gets a value indicating whether the ZipArchive object is disposed.
|
| IsReadOnly |
Gets a value indicating whether the ZIP archive is only open for reading.
|
| Item |
Gets the ZipItem object that represents the specified path.
|
| LogWriter |
Gets or sets the logger used by this object.
|
| Options |
Gets the archive options object.
|
| Password |
Gets or sets a password. Null reference (Nothing in Visual Basic) means don't encrypt newly added files.
|
| SaveMode |
Gets or sets a save mode, which determines when changes are saved to the underlying stream.
|
Events
| Name | Description | |
|---|---|---|
 | AddCompleted |
Occurs when the asynchronous call of the AddAsync or the AddFileAsync method is completed (or canceled or raised an exception).
|
| DeleteCompleted |
Occurs when the asynchronous call of the DeleteAsync method is completed (or canceled or raised an exception).
|
| ExtractCompleted |
Occurs when the asynchronous call of the ExtractAsync or the ExtractFileAsync method is completed (or canceled or raised an exception).
|
| GetItemsCompleted |
Occurs when the asynchronous call of the GetItemsAsync method is completed (or canceled or raised an exception).
|
| MoveCompleted |
Occurs when the asynchronous call of the MoveAsync method is completed (or canceled or raised an exception).
|
| PasswordRequired |
Occurs when a password is needed for decompressing an item.
|
| ProblemDetected |
Occurs when a problem is detected in Add, Extract, Delete or GetItems methods, making it possible for the handler to choose a desired action.
|
| ProgressChanged |
Occurs when a significant action occurs in Add, Extract, Delete, GetItems methods.
|
| SaveCompleted |
Occurs when the asynchronous call of the SaveAsync method is completed (or canceled or raised an exception).
|
| ShrinkProgress |
Occurs when a data block is processed while shrinking the archive.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IDisposable..::..Dispose | |
| IEnumerable..::..GetEnumerator |
See Also
