Hide Table of Contents

Start, Update, and Stop Progress Indicator Example (VB.NET)

This example shows how to create, start, update, and stop a progress indicator on the system task bar.

' Preconditions:
' 1. Create a VB.NET macro in SOLIDWORKS.
' 2. Right-click the macro project name in the Project Explorer and click
'    Add > Windows Form
' 3. Click Add.
' 4. Modify Form1.vb [Design] to look like this:


' 5. Copy Forms - Form1 into Form1.vb.
' 6. Modify control_name in each control_name_Click subroutine to
'    match your form.
' 7. Copy
SolidWorksMacro into SolidWorksMacro.vb.
' 8. Open the Immediate window.
' Postconditions: 
' 1. Shows a dialog box.
' 2. Click Start.
'    * Displays a progress indicator on the SOLIDWORKS icon on the
'      system taskbar.
'    * Increments the progress indicator to 100% completion.
' 3. Click Update repeatedly to increment the progress indicator in steps of
'    10.
' 4. Inspect the Immediate window to see the return code after each update.
' 5. Type a new title and click Update Title to change the progress indicator
'    title.
' 6. Click Stop to remove the progress indicator from SOLIDWORKS.
' 7. Click Exit to close the dialog box.

' ---------------------------------------------------------------------------

Forms - Form1

Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System.Runtime.InteropServices
Imports System
Imports System.Diagnostics
Public Class Form1
    Dim pb As UserProgressBar
    Dim Position As Integer
    Dim lRet As Integer
    Dim retVal As Boolean
    Dim boolstatus As Boolean
    Public swApp As SldWorks
    Public Sub cmdExit_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles cmdExit.Click
    End Sub

    Public Sub cmdPBTitle_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles cmdPBTitle.Click
        retVal = pb.UpdateTitle(TextBox1.Text)
    End Sub

    Public Sub cmdStartPB_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles cmdStartPB.Click
        boolstatus = pb.Start(0, 160, "Status")
        Do While Not (Position = 160)
            Position = Position + 10
            lRet = pb.UpdateProgress(Position)
        Position = 0
    End Sub

    Public Sub cmdStopPB_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles cmdStopPB.Click
    End Sub

    Public Sub Form1_Initialize(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Me.Load
        swApp = CType(System.Runtime.InteropServices.Marshal.GetActiveObject("SldWorks.Application"), SldWorks)
        retVal = swApp.GetUserProgressBar(pb)
    End Sub

    Public Sub cmdUpdatePB_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles cmdUpdatePB.Click
        Position = Position + 10
        If (Position = 160) Then Position = 0
        lRet = pb.UpdateProgress(Position)
        If lRet <> 2 Then
            Debug.Print(" Result " & lRet)
            MsgBox(" User pressed Esc to cancel ", vbInformation, " API")
        End If
    End Sub

    Private Sub TextBox1_TextChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles TextBox1.TextChanged
    End Sub
End Class


Back to top


Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System.Runtime.InteropServices
Imports System
Partial Class SolidWorksMacro
    Dim aForm As Windows.Forms.Form
    Public Sub main()
        aForm = New Form1
    End Sub
    Public swApp As SldWorks
End Class

Back to top


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   Start, Update, and Stop Progress Indicator Example (VB.NET)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2017 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.