Hide Table of Contents

Add Buttons to Task Pane (VB.NET)

This example shows how to add standard SOLIDWORKS and custom buttons to the Task Pane.

' Preconditions:
' 1. SOLIDWORKS is running.
' 2. Copy the custom button images, localHelp.bmp and save.png, from
'    install_dir\samples\tutorial\api to this macro's folder.
' 3. Clear the Stop VSTA debugger on macro exit checkbox if selected
'    in Tools >
Options in SOLIDWORKS.
' Postconditions:
' 1. The Task Pane, with Microsoft Calendar control loaded, opens
'    with the specified SOLIDWORKS standard and custom buttons at the
'    top of the pane.
' 2. Click each button from left to right. A message box is displayed
'    after each button click. The message box might appear on the taskbar,
'    so examine the taskbar and click the message box to open it.
'    Additionally, clicking the Close button prompts you to remove
'    the control from the Task Pane.
' 3. Click the Stop Debugging button in the IDE.
' 4. Select the Stop VSTA debugger on macro exit checkbox in
Tools > Options in SOLIDWORKS, if you want to turn it back on.
Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System
Imports System.Collections
Imports System.Diagnostics

Partial Class SolidWorksMacro

Public WithEvents swTaskPane As TaskpaneView
Public buttonIdx As Integer

    Public Sub Main()

Dim result As Boolean
        Dim folder As String
        Dim bitmap As String
        Dim toolTip As String
        Dim ctrlName As String
        Dim ctrlLicKey As String

        folder = swApp.GetCurrentMacroPathFolder + "\"

        ' Use default image for Task Pane tab
        bitmap = ""
        toolTip = "Microsoft Calendar"
        ctrlName = "MSCAL.Calendar"
        ctrlLicKey = ""
        swTaskPane = swApp.CreateTaskpaneView2(bitmap, toolTip)

' Add standard and custom buttons to Task Pane
        result = swTaskPane.AddCustomButton(folder & "localHelp.bmp", "Help (custom bmp)")
        result = swTaskPane.AddCustomButton(folder &
"save.png", "Save (custom png)")
        result = swTaskPane.AddStandardButton(swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Next,
"Next (standard)")
        result = swTaskPane.AddStandardButton(swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Back,
"Back (standard)")
        result = swTaskPane.AddStandardButton(swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Ok,
"OK (standard)")
        result = swTaskPane.AddStandardButton(swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Close,
"Close (standard)")

' Add control to Task Pane for the buttons
        swTaskPane.AddControl(ctrlName, ctrlLicKey)

' Set up events

End Sub

    Sub AttachEventHandlers()
End Sub

    Sub AttachSWEvents()
AddHandler swTaskPane.TaskPaneActivateNotify, AddressOf Me.swTaskPane_TaskPaneActivateNotify
AddHandler swTaskPane.TaskPaneDestroyNotify, AddressOf Me.swTaskPane_TaskPaneDestroyNotify
AddHandler swTaskPane.TaskPaneToolbarButtonClicked, AddressOf Me.swTaskPane_TaskPaneToolbarButtonClicked
End Sub

    Public Function swTaskPane_TaskPaneActivateNotify() As Integer
        If Not (swTaskPane.GetButtonState(0)) Then
            For buttonIdx = 0 To 20
, True)
            For buttonIdx = 0 To 20
                swTaskPane.SetButtonState(buttonIdx, False)

        End If
    End Function

    Public Function swTaskPane_TaskPaneDestroyNotify() As Integer
        MsgBox("Remove control from Task Pane?")
End Function

    Public Function swTaskPane_TaskPaneToolbarButtonClicked(ByVal ButtonIndex As Integer) As Integer
        Select Case (ButtonIndex + 1)
Case 1
"Help (custom bmp) button clicked.")
Case 2
"Save (custom png) button clicked.")
Case 3
"Next button clicked.")
Case 4
"Back button clicked.")
Case 5
"Okay button clicked.")
Case 6
"Close button clicked.")
End Select

    End Function

    ''' <summary>
    ''' The SldWorks swApp variable is pre-assigned for you.
    ''' </summary>
    Public swApp As SldWorks



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:   Add Buttons to Task Pane (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) 2016 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.