Catalyst File Transfer .NET

FileTransfer.OnProgress Event

Occurs as a data stream is being read or written to the server.

[Visual Basic]
Public Event OnProgress As OnProgressEventHandler
[C#]
public event OnProgressEventHandler OnProgress;

Event Data

The event handler receives an argument of type FileTransfer.ProgressEventArgs containing data related to this event. The following FileTransfer.ProgressEventArgs properties provide information specific to this event.

Property Description
BytesCopied Gets a value which specifies the number of bytes of data that has been read or written.
FileName Gets a value which specifies a file name.
FileSize Gets a value which specifies the size of the file being transferred.
Percent Gets a value which specifies the percentage of data that has been read or written.

Remarks

The OnProgress event occurs as a data stream is being read or written to the server. If large amounts of data are being read or written, this event can be used to update a progress bar or other user-interface component to provide the user with some visual feedback on the progress of the operation.

See Also

FileTransfer Class | SocketTools Namespace