Progress Event
Fired as progress is made.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, OfficedocProgressEventArgs e); public class OfficedocProgressEventArgs : EventArgs { public string Data { get; }
public byte[] DataB { get; } public string Filename { get; } public long BytesProcessed { get; } public int PercentProcessed { get; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As OfficedocProgressEventArgs) Public Class OfficedocProgressEventArgs Inherits EventArgs Public ReadOnly Property Data As String
Public ReadOnly Property DataB As Byte() Public ReadOnly Property Filename As String Public ReadOnly Property BytesProcessed As Long Public ReadOnly Property PercentProcessed As Integer End Class
Remarks
The Progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.
Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.
BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.
For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.
If WriteToProgressEvent is false, Data will contain null.