Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / ZipEvents Class


In This Topic
    ZipEvents Class
    In This Topic
    Class that dispatches events associated with zip operations performed on ZippedFile, ZippedFolder or ZipArchive objects.
    Object Model
    ZipEvents ClassFileSystemEventsSession Class
    Syntax
    'Declaration
     
    
    Public Class ZipEvents 
       Inherits Xceed.FileSystem.FileSystemEvents
    'Usage
     
    
    Dim instance As ZipEvents
    public class ZipEvents : Xceed.FileSystem.FileSystemEvents 
    Inheritance Hierarchy

    System.Object
       Xceed.FileSystem.FileSystemEvents
          Xceed.Zip.ZipEvents

    Public Constructors
     NameDescription
    Public ConstructorClass that dispatches events associated with zip operations performed on ZippedFile, ZippedFolder or ZipArchive objects.  
    Top
    Protected Properties
     NameDescription
    Protected Internal Property (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal PropertyGets a boolean value indicating if the ZipEvents object has subscribed to the BuildingZipByteProgression event.  
    Protected Internal PropertyGets a boolean value indicating if the ZipEvents object has subscribed to the BuildingZipItemProgression event.  
    Protected Internal PropertyGets a boolean value indicating if the Xceed.FileSystem.FileSystemEvents object has subscribed to the Xceed.FileSystem.FileSystemEvents.ByteProgression event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal PropertyGets a boolean value indicating if the ZipEvents object has subscribed to the CopyingZipByteProgression event.  
    Protected Internal PropertyGets a boolean value indicating if the ZipEvents object has subscribed to the DiskRequired event.  
    Protected Internal PropertyGets a boolean value indicating if the ZipEvents object has subscribed to the GatheringZipContentByteProgression event.  
    Protected Internal PropertyGets a System.Boolean value indicating if the FileSystemEvents object has subscribed to the ItemCompletion event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal PropertyGets a boolean value indicating if the Xceed.FileSystem.FileSystemEvents object has subscribed to the Xceed.FileSystem.FileSystemEvents.ItemException event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal PropertyGets a boolean value indicating if the Xceed.FileSystem.FileSystemEvents object has subscribed to the Xceed.FileSystem.FileSystemEvents.ItemProgression event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal PropertyGets a boolean value indicating if the FileSystemEvents object has subscribed to the PathException event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal Property (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal PropertyGets a boolean value indicating if the ZipEvents object has subscribed to the ReadingZipItemProgression event.  
    Protected Internal PropertyGets a boolean value indicating if the Xceed.FileSystem.FileSystemEvents object has subscribed to the Xceed.FileSystem.FileSystemEvents.ScanningFolder event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Top
    Public Methods
     NameDescription
    Public MethodCalled when a sub-operation is begun within a process. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public MethodOverloaded. Overridden. Creates a new session from a ZipEvents object.  
    Public MethodCalled when a sub-operation is ended within a process. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Top
    Protected Methods
     NameDescription
    Protected Internal Method (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal MethodRaises the BuildingZipByteProgression event.  
    Protected Internal MethodRaises the BuildingZipItemProgression event.  
    Protected Internal MethodRaises the Xceed.FileSystem.FileSystemEvents.ByteProgression event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal MethodOBSOLETE : This method should no longer be called. You can override OnGatheringZipContentByteProgression to get status on the step preceding the creation of the zip file. Raises the CopyingZipByteProgression event.  
    Protected Internal MethodRaises the DiskRequired event.  
    Protected Internal MethodRaises the GatheringZipContentByteProgression event.  
    Protected Internal MethodRaises the ItemCompletion event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal MethodRaises the Xceed.FileSystem.FileSystemEvents.ItemException event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal MethodRaises the Xceed.FileSystem.FileSystemEvents.ItemProgression event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal MethodRaises the PathException event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal Method (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected Internal MethodRaises the ReadingZipItemProgression event.  
    Protected Internal MethodRaises the Xceed.FileSystem.FileSystemEvents.ScanningFolder event. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Protected MethodVerifies the validity of the parameters sent to the event handlers. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Top
    Public Events
     NameDescription
    Public EventRaised every time a Xceed.FileSystem.FileSystemItem object is about to be added to the list of items to be processed, providing information to the event handler and optional actions to be taken. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public EventRaised every time a target zip file is being built, providing byte progression information to the event handler.  
    Public EventRaised every time a target zip file is being built, providing item progression information to the event handler.  
    Public EventRaised for every 64k of bytes processed when a Xceed.FileSystem.FileSystemItem object is being processed. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public EventOBSOLETE : This event is no longer raised. You can use the GatheringZipContentByteProgression event to retrieve progress information during the step preceding the creation of the actual zip file. Raised every time the temporary zip file replaces the existing zip file, providing byte progression information to the event handler.  
    Public EventRaised when a new disk or split part is required.  
    Public EventRaised during the step preceding the actual creation of the target zip file, where files to keep from the original zip file (the ones that were not modified) are gathered to a temporary location before overwriting the zip file.  
    Public EventRaised every time a FileSystemItem object has been processed, providing progression information to the event handler and the ability to perform custom post-processing on the target item. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public EventRaised when an exception is caught during the processing of a Xceed.FileSystem.FileSystemItem object, allowing the handler to decide the action to take. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public EventRaised every time a Xceed.FileSystem.FileSystemItem object is about to be processed, providing progression information to the event handler. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public EventRaised when an exception is caught during the processing of a path string, allowing the handler to correct the path and retry the operation. (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public Event (Inherited from Xceed.FileSystem.FileSystemEvents)
    Public EventRaised every time a zip file is being read for the first time or being refreshed, providing progression information to the event handler.  
    Public EventRaised when an Xceed.FileSystem.AbstractFolder object is accessed or is scanned for matching items while building a list of items to process. (Inherited from Xceed.FileSystem.FileSystemEvents)
    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 Standard: netstandard2.0, netstandard2.1

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

    See Also