Hide Table of Contents

Add Buttons to Task Pane Example (C#)

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

// 1. Copy save.png from public_documents\samples\tutorial\api to this macro's
//    SwMacro folder.
// 2. Clear the Stop VSTA debugger on macro exit check box if selected
//    in Tools > Options > System Options.
// 3. Open the Immediate window.
// Postconditions:
// 1. Opens the Task Pane and loads the My Calendar control with
//    the specified standard and custom buttons at the
//    top of the pane.
// 2. Click each button from left to right and examine the Immediate
//    window after each click.
// 3. Click the Stop Debugging button in the IDE.
// 4. Select the Stop VSTA debugger on macro exit check box in
//    Tools > Options > System Options if cleared in
//    Preconditions step 2.

using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using System;
using System.Collections;
using System.Windows.Forms;
using System.Diagnostics;

namespace Macro1CSharp.csproj
partial class SolidWorksMacro

public TaskpaneView swTaskPane;
public int buttonIdx;

public void Main()

bool result = false;
string folder = null;
string bitmap = null;
string toolTip = null;
string ctrlName = null;
string ctrlLicKey = null;

            folder = swApp.GetCurrentMacroPathFolder() +

// Use default image for Task Pane tab
            bitmap = "";
            toolTip =
"My Calendar";
            ctrlName =
            ctrlLicKey =
            swTaskPane = (TaskpaneView)swApp.CreateTaskpaneView2(bitmap, toolTip);

// Add standard and custom buttons to Task Pane
            result = swTaskPane.AddCustomButton(folder + "save.png", "Save (custom png)");
            result = swTaskPane.AddStandardButton((
int)swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Next, "Next (standard)");
            result = swTaskPane.AddStandardButton((
int)swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Back, "Back (standard)");
            result = swTaskPane.AddStandardButton((
int)swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Ok, "OK (standard)");
            result = swTaskPane.AddStandardButton((
int)swTaskPaneBitmapsOptions_e.swTaskPaneBitmapsOptions_Close, "Close (standard)");

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

// Set up events


public void AttachEventHandlers()

public void AttachSWEvents()
            swTaskPane.TaskPaneActivateNotify +=
            swTaskPane.TaskPaneDestroyNotify +=
            swTaskPane.TaskPaneToolbarButtonClicked +=

public int swTaskPane_TaskPaneActivateNotify()
if (swTaskPane.GetButtonState(0) == false)
for (buttonIdx = 0; buttonIdx <= 20; buttonIdx++)
for (buttonIdx = 0; buttonIdx <= 20; buttonIdx++)
return 0;

public int swTaskPane_TaskPaneDestroyNotify()
"Remove control from Task Pane?");
return 1;

public int swTaskPane_TaskPaneToolbarButtonClicked(int ButtonIndex)
switch ((ButtonIndex + 1))
case 1:
Debug.Print("Save (custom png) button clicked.");
case 2:
Debug.Print("Next button clicked.");
case 3:
Debug.Print("Back button clicked.");
case 4:
Debug.Print("Okay button clicked.");
case 5:
Debug.Print("Close button clicked and tab deleted.");
return 1;

/// <summary>
        /// The SldWorks swApp variable is pre-assigned for you.
        /// </summary>
SldWorks swApp;


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 Example (C#)
*   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) 2018 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.