PowerTCP Zip Compression for .NET
Archive Class Members
Properties  Methods  Events


The following tables list the members exposed by Archive.

Public Constructors
 NameDescription
Public ConstructorArchive ConstructorInitializes a new instance of Archive.  
Top
Public Properties
 NameDescription
Public PropertyBusy Returns true if a method is currently in use.  
Public PropertyCommentGets or sets the comment for the entire collection.  
Public PropertyCompressionLevelGets or sets the compression level for data compression.  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyContainsListCollectionGets a value indicating whether the collection is a collection of IList objects.  
Public PropertyCountGets the number of ArchiveItem objects in the archive.  
Public PropertyDefaultCompressionMethodGets or sets the default compression algorithm used for data compression.  
Public PropertyDefaultEncryptionGets or sets the encryption algorithm used for the archive.  
Public PropertyDelimiterGets or sets a character to be used as a Delimiter when adding items to an Archive.  
Public PropertyDestinationDirectoryGets or sets the default compression algorithm used for data compression.  
Public PropertyDoEvents Gets or sets a value that controls the processing of events during blocking method calls.  
Public PropertyEncoding Gets or sets the character encoding used for filenames.  
Public PropertyExcludePatternGets or sets the files to exclude when using wildcards.  
Public PropertyFormatGets the compression format of the archive.  
Public PropertyIncludeSubsGets or sets whether subdirectories are included when using wildcards.  
Public PropertyIsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread-safe).  
Public PropertyItemGets or sets the object at the specified index.  
Public PropertyItemsGets an ArrayList containing ArchiveItem objects.  
Public PropertyMaxMemoryStreamSizeGets or sets a value (in kilobytes) which determines when buffering to a temporary file is necessary.  
Public PropertyOverwriteGets or sets a value which determines how files are overwritten when decompressing files.  
Public PropertyPasswordGets or sets the encryption password for the archive.  
Public PropertyPreservePathGets or sets a value which determines if file paths are preserved when compressing or decompressing.  
Public PropertyProgressSizeGets or sets the frequency to raise the Progress event.  
Public PropertySelfExtractConfigurationGets or sets a SelfExtractConfiguration object, which is used to define the specification of a self-extraction operation.  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertySizeGets the number of uncompressed bytes by summing the size of all files in the archive.  
Public PropertySpanConfigurationGets or sets a SpanConfiguration object, which is used to span or split an archive over multiple volumes.  
Public PropertySynchronizingObjectSet this object to automatically control thread marshalling between worker threads and the main UI thread.  
Public PropertySyncRootGets an object that can be used to synchronize access to the Archive.  
Public PropertyTag Gets or sets an object reference that can be used to associate this instance with any other. Gets or sets an object reference that can be used to associate this instance with any other.  
Public PropertyTempFileDirectoryGets or sets a value indicating the directory to store any temporary files created during compression operations.  
Public PropertyVolumeLabelGets or sets the volume label.  
Top
Protected Properties
Public Methods
 NameDescription
Public MethodAbortAborts the current operation.  
Public MethodAddOverloaded. Adds an item or items to the archive.  
Public MethodBeginQuickUnzipOverloaded. Asynchronously open and decompress a zip archive.  
Public MethodBeginQuickZipOverloaded. Asynchronously add files and create a zip archive.  
Public MethodBeginUnzipAsynchronously decompress the items in a zip archive that have been opened.  
Public MethodBeginZipOverloaded. Asynchronously compress the items in the current collection and generate a zip archive written to a Stream.  
Public MethodClear Removes all elements from the ArrayList.  
Public MethodCopyTo Copies the entire ArrayList to a compatible one-dimensional Array, starting at the specified index of the target array.  
Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Releases all resources associated with the object.  
Public MethodGetEnumerator Returns an enumerator for the collection.  
Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
Public MethodGetListReturns an IList that can be bound to a data source from an object that does not implement an IList itself.  
Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
Public MethodInsertOverloaded. Inserts one or more items into the collection starting from the specified index.  
Public MethodOpenOverloaded. Opens a compressed archive and populates the collection to reflect the items in the compressed archive.  
Public MethodQuickUnzipOverloaded. Opens a compressed archive and decompresses it in one step.  
Public MethodQuickZipOverloaded. Adds a file or files and compresses in one step.  
Public MethodRead Reads at least one byte of compressed data from the Archive and copies it into the provided buffer.  
Public MethodRemoveAtRemoves an element at the specified index from the collection.  
Public MethodRemoveRange Removes a range of elements from an ArrayList or collection.  
Public MethodResetRemoves the elements in the collection and reset all of the properties of the collection to their defaults.  
Public MethodToString (Inherited from System.ComponentModel.Component)
Public MethodUnzipDecompresses the items in the current collection to the specified directory  
Public MethodWrite Writes a sequence of compressed bytes to the Archive and returns when the operation is complete.  
Public MethodZipOverloaded. Compresses the items in the current collection and generates a compressed archive.  
Top
Protected Methods
 NameDescription
Protected MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodGetService (Inherited from System.ComponentModel.Component)
Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
Top
Public Events
 NameDescription
Public EventBusyChangedOccurs when the Busy property in the Archive component gets changed.  
Public EventDiskOccurs when a removable media volume is needed during a spanning process.  
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventEndUnzipOccurs when an asynchronous Unzip operation completes  
Public EventEndZipOccurs when an asynchronous zip operation completes  
Public EventExceptionOccurs to report a warning condition that is not a fatal error.  
Public EventProgressOccurs to indicate the progress of the current compression or decompression activity.  
Public EventSpanProgressOccurs to indicate the progress of a spanning operation. This event has been deprecated and is no longer raised.  
Top
See Also

Reference

Archive Class
Dart.PowerTCP.Zip Namespace


PowerTCP Zip for .NET Documentation Version 2.1.1
© 2018 Dart Communications. All Rights Reserved.
Send comments on this topic