Xceed Logo
Shop
Xceed Real-Time Zip for .NET Documentation
Xceed.Zip Assembly / Xceed.Zip.ReaderWriter Namespace / ZipWriter Class


In This Topic
    ZipWriter Class
    In This Topic
    Represents an object used to create and write to a Zip file passed to it as a stream.
    Syntax
    'Declaration
 
Public Class ZipWriter 
   Implements System.IDisposable 
    'Usage
 
Dim instance As ZipWriter
    public class ZipWriter : System.IDisposable 
    Inheritance Hierarchy

    System.Object
       Xceed.Zip.ReaderWriter.ZipWriter

    Public Constructors
     NameDescription
    Public ConstructorZipWriter ConstructorOverloaded. Initializes a new instance of the ZipWriter class.  
    Top
    Public Properties
     NameDescription
    Public PropertyAesAlgorithmManagerGets or sets a manager object for the AES encryption functionality.  
    Public PropertyAllowOutputStreamClosureGets or sets a boolean value indicating whether the output stream can be closed by the object.  
    Public PropertyAllowUncompressedDataGets or sets a boolean value indicating whether the ZipWriter is allowed to write true uncompressed data in the Zip archive.  
    Public PropertyAllowZip64ExtensionsGets a boolean value indicating whether Zip64 extensions of the Zip specification are enabled.  
    Public PropertyDefaultPasswordTextEncoding  
    Public PropertyMultiThreadManager  
    Public PropertyOutputStreamGets the output Stream object that was specified at construction.  
    Public PropertyTextEncodingGets or sets the text encoding that will be applied to files that are added to the zip archive.  
    Public PropertyUnknownCharacterFallbackConversion  
    Public PropertyUseLocalMachineOEMCodePageForFilenames  
    Public PropertyUseUnsafeCompressionMethodVersionsGets or sets a System.Boolean value that indicates whether the currently selected compression and decompression methods can use "unsafe" techniques like pointers to increase speed.  
    Top
    Public Methods
     NameDescription
    Public MethodCloseZipFileOverloaded. Closes the Zip file by writing the data descriptor for the last item and then writing the central header, the end header locator (optionally, for Zip64), and the end header.  
    Public MethodDisposeOverloaded. 

    Provides correct cleanup of resources in the base class and its derived classes.

     
    Public MethodGetItemDataStreamReturns a new Stream object that implements a write-only stream around the WriteItemData method.  
    Public MethodQueueItemOverloaded.   
    Public MethodWriteItemDataOverloaded. Writes a sequence of bytes to the ZipWriter object's stream and advances the position within the stream by the number of bytes written.  
    Public MethodWriteItemLocalHeaderWrites a local header to the Zip file.  
    Top
    Public Events
     NameDescription
    Public EventByteProgressionRaised when WriteItemData has been called.  
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    ZipWriter Members
    Xceed.Zip.ReaderWriter Namespace

    Send Feedback