Syntax
| Visual Basic (Declaration) | |
|---|---|
<CategoryAttribute("Progress")> <DescriptionAttribute("Raised to report progress while getting mail messages.")> Public Event Progress As PopProgressEventHandler | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As Pop Dim handler As PopProgressEventHandler AddHandler instance.Progress, handler | |
| C# | |
|---|---|
[CategoryAttribute("Progress")] [DescriptionAttribute("Raised to report progress while getting mail messages.")] public event PopProgressEventHandler Progress | |
| Managed Extensions for C++ | |
|---|---|
[CategoryAttribute("Progress")] [DescriptionAttribute("Raised to report progress while getting mail messages.")] public: __event PopProgressEventHandler* Progress | |
| C++/CLI | |
|---|---|
[CategoryAttribute("Progress")] [DescriptionAttribute("Raised to report progress while getting mail messages.")] public: event PopProgressEventHandler^ Progress | |
Event Data
The event handler receives an argument of type PopProgressEventArgs containing data related to this event. The following PopProgressEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Length | The length of the stream. |
| PopMessage | Gets the PopMessage representing the message currently being retrieved. |
| Position | The position within the stream. |
Remarks
When a message is retrieved from the server, the Pop.Progress event will be raised in the frequency specified by Pop.Connection.ReceiveBufferSize. This event will contain data useful for displaying progress to the user. For example, if you wish to display progress for the retrieval of ALL messages, use 0 for minimum, pop1.Messages.Length for maximum, and PopMessage.Id as value. If you wish to display progress for each message, use 0 for minimum, PopProgressEventArgs.Length for maximum, and PopProgressEventArgs.Position for the value.
For more information on using events using PowerTCP within the Visual Studio .NET environment, see Using Events Within The Visual Studio.NET Environment.
If you are using the Pop component as a reference, you must create a method to handle the event yourself. To learn how to do this, see Using Events When A Component Is Used As A Reference.
Requirements
Target Platforms: Microsoft .NET Framework 2.0