DevBackgroundWorker Class

<ToolboxBitmapAttribute(GetType(BackgroundWorker))>
<DefaultEventAttribute("DoWork")>
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := true)>
Public Class DevBackgroundWorker
	Inherits BackgroundWorker

Dim instance As DevBackgroundWorker

[ToolboxBitmapAttribute(typeof(BackgroundWorker))]
[DefaultEventAttribute(L"DoWork")]
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public ref class DevBackgroundWorker : public BackgroundWorker

[<ToolboxBitmapAttribute(typeof(BackgroundWorker))>]
[<DefaultEventAttribute("DoWork")>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)>]
type DevBackgroundWorker = 
    class
        inherit BackgroundWorker
    end

No code example is currently available or this language may not be supported.

Friend WithEvents Worker As DevBackgroundWorker

Private Sub Button_Run_Click() Handles Button_Run.Click

    If (Me.Worker IsNot Nothing) Then

        Select Case Me.Worker.State
            Case DevBackgroundWorkerState.Running, DevBackgroundWorkerState.Paused
                Me.Worker.Cancel()
            Case Else
                ' Do Nothing.
        End Select

    End If

    Me.Worker = New DevBackgroundWorker
    Me.Worker.RunAsync()

End Sub

Private Sub Button_Pause_Click() Handles Button_Pause.Click
    Me.Worker.RequestPause()
End Sub

Private Sub Button_Resume_Click() Handles Button_Resume.Click
    Me.Worker.Resume()
End Sub

Private Sub Button_Cancel_Click() Handles Button_Cancel.Click
    Me.Worker.Cancel()
End Sub

''' ----------------------------------------------------------------------------------------------------
''' <summary>
''' Handles the <see cref="DevBackgroundWorker.DoWork"/> event of the <see cref="Worker"/> instance.
''' </summary>
''' ----------------------------------------------------------------------------------------------------
''' <param name="sender">
''' The source of the event.
''' </param>
''' 
''' <param name="e">
''' The <see cref="DoWorkEventArgs"/> instance containing the event data.
''' </param>
''' ----------------------------------------------------------------------------------------------------
<DebuggerStepperBoundary>
Private Sub Worker_DoWork(ByVal sender As Object, ByVal e As DoWorkEventArgs) _
Handles Worker.DoWork

    Dim progress As Integer

    Dim lock As Object = ""
    SyncLock lock

        For i As Integer = 0 To 100
            If (Me.Worker.CancellationPending) Then ' Cancel the background operation.
                e.Cancel = True
                Exit For

            Else
                If (Me.Worker.PausePending) Then ' Pause the background operation.
                    Me.Worker.Pause() ' Blocking pause call.
                End If

                Me.DoSomething()

                If Me.Worker.WorkerReportsProgress Then
                    progress = i
                    Me.Worker.ReportProgress(progress)
                End If

            End If

        Next i

    End SyncLock

    If (Me.Worker.WorkerReportsProgress) AndAlso Not (Me.Worker.CancellationPending) AndAlso (progress < 100) Then
        Me.Worker.ReportProgress(percentProgress:=100)
    End If

End Sub

''' ----------------------------------------------------------------------------------------------------
''' <summary>
''' Handles the <see cref="DevBackgroundWorker.ProgressChanged"/> event of the <see cref="Worker"/> instance.
''' </summary>
''' ----------------------------------------------------------------------------------------------------
''' <param name="sender">
''' The source of the event.
''' </param>
''' 
''' <param name="e">
''' The <see cref="ProgressChangedEventArgs"/> instance containing the event data.
''' </param>
''' ----------------------------------------------------------------------------------------------------
<DebuggerStepperBoundary>
Private Sub Worker_ProgressChanged(ByVal sender As Object, ByVal e As ProgressChangedEventArgs) _
Handles Worker.ProgressChanged

    Console.WriteLine(String.Format("Background Work Progress: {00}%", e.ProgressPercentage))

End Sub

''' ----------------------------------------------------------------------------------------------------
''' <summary>
''' Handles the <see cref="DevBackgroundWorker.RunWorkerCompleted"/> event of the <see cref="Worker"/> instance.
''' </summary>
''' ----------------------------------------------------------------------------------------------------
''' <param name="sender">
''' The source of the event.
''' </param>
''' 
''' <param name="e">
''' The <see cref="RunWorkerCompletedEventArgs"/> instance containing the event data.
''' </param>
''' ----------------------------------------------------------------------------------------------------
<DebuggerStepperBoundary>
Private Sub Worker_RunWorkerCompleted(ByVal sender As Object, ByVal e As RunWorkerCompletedEventArgs) _
Handles Worker.RunWorkerCompleted

    If (e.Cancelled) Then
        Debug.WriteLine("Background work cancelled.")

    ElseIf (e.Error IsNot Nothing) Then
        Debug.WriteLine("Background work error.")

    Else
        Debug.WriteLine("Background work done.")

    End If

    Console.WriteLine(String.Format("State: {0}", Me.Worker.State.ToString()))

End Sub

<DebuggerStepperBoundary>
Private Sub DoSomething()
    Thread.Sleep(TimeSpan.FromSeconds(1))
End Sub

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.