Export (0) Print
Expand All

DoWorkEventArgs.Argument Property

Gets a value that represents the argument of an asynchronous operation.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)

'Declaration
Public ReadOnly Property Argument As Object

Property Value

Type: System.Object
An Object representing the argument of an asynchronous operation.

The following code example demonstrates how to use the DoWorkEventArgs class to handle the DoWork event. For a full code listing, see How to: Run an Operation in the Background.

Private Sub backgroundWorker1_DoWork( _
sender As Object, e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

   ' Do not access the form's BackgroundWorker reference directly. 
   ' Instead, use the reference provided by the sender parameter. 
   Dim bw As BackgroundWorker = CType( sender, BackgroundWorker )

   ' Extract the argument. 
   Dim arg As Integer = Fix(e.Argument)

   ' Start the time-consuming operation.
   e.Result = TimeConsumingOperation(bw, arg)

   ' If the operation was canceled by the user,  
   ' set the DoWorkEventArgs.Cancel property to true. 
   If bw.CancellationPending Then
      e.Cancel = True 
   End If 

End Sub   

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft