SocketTools .NET Edition

GopherClient.OnProgress Event

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

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

Event Data

The event handler receives an argument of type GopherClient.ProgressEventArgs containing data related to this event. The following GopherClient.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.
BytesTotal Gets a value which specifies the total number of bytes in the data stream.
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 client. 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.

This event is only generated when the GetItem or StoreItem methods are called.

See Also

GopherClient Class | SocketTools Namespace