Progress Event
Fired as progress is made.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, XmlencryptProgressEventArgs e); public class XmlencryptProgressEventArgs : EventArgs { public long BytesProcessed { get; } public int PercentProcessed { get; } public int Operation { get; } public bool IsEOF { get; set; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As XmlencryptProgressEventArgs) Public Class XmlencryptProgressEventArgs Inherits EventArgs Public ReadOnly Property BytesProcessed As Long Public ReadOnly Property PercentProcessed As Integer Public ReadOnly Property Operation As Integer Public Property IsEOF As Boolean End Class
Remarks
This event is fired automatically as data is processed by the component.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:
0 | None |
1 | Read |
2 | Write |
The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the component. When the Operation is Write (2) this value may be queried to determine when all data has been processed.