Hide Table of Contents

Add Buttons to Task Pane (C#)

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
//    <SolidWorks_install_folder>\samples\tutorial\api to this macro's
//    swMacro folder.
// 3. Clear the Stop VSTA debugger on macro exit checkbox, if selected
//    (click Tools > Options to display the System Options - General
//    dialog), 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
//    SolidWorks, if you want to turn it back on.
//----------------------------------------------------------------
using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using System;
using System.Collections;
using System.Windows.Forms;
using System.Diagnostics;

namespace TaskPaneViewButtonsCSharp.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 =
"Microsoft Calendar";
            ctrlName =
"MSCAL.Calendar";
            ctrlLicKey =
"";
            swTaskPane = (TaskpaneView)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((
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

            AttachEventHandlers();
        }

        
public void AttachEventHandlers()
        {
            AttachSWEvents();
        }

        
public void AttachSWEvents()
        {
            swTaskPane.TaskPaneActivateNotify +=
this.swTaskPane_TaskPaneActivateNotify;
            swTaskPane.TaskPaneDestroyNotify +=
this.swTaskPane_TaskPaneDestroyNotify;
            swTaskPane.TaskPaneToolbarButtonClicked +=
this.swTaskPane_TaskPaneToolbarButtonClicked;
        }

        
public int swTaskPane_TaskPaneActivateNotify()
        {
            
if (swTaskPane.GetButtonState(0) == false)
            {
                
for (buttonIdx = 0; buttonIdx <= 20; buttonIdx++)
                {
                    swTaskPane.SetButtonState(buttonIdx,
true);
                }
            }
            
else
            {
                
for (buttonIdx = 0; buttonIdx <= 20; buttonIdx++)
                {
                    swTaskPane.SetButtonState(buttonIdx,
false);
                }
            }
            
return 0;
        }

        
public int swTaskPane_TaskPaneDestroyNotify()
        {
            MessageBox.Show(
"Remove control from Task Pane?");
            
return 1;
        }

        
public int swTaskPane_TaskPaneToolbarButtonClicked(int ButtonIndex)
        {
            
switch ((ButtonIndex + 1))
            {
                
case 1:
                    MessageBox.Show(
"Help (custom bmp) button clicked.");
                    
break;
                
case 2:
                    MessageBox.Show(
"Save (custom png) button clicked.");
                    
break;
                
case 3:
                    MessageBox.Show(
"Next button clicked.");
                    
break;
                
case 4:
                    MessageBox.Show(
"Back button clicked.");
                    
break;
                
case 5:
                    MessageBox.Show(
"Okay button clicked.");
                    
break;
                
case 6:
                    MessageBox.Show(
"Close button clicked.");
                    swTaskPane.DeleteView();
                    
break;
            }
            
return 1;
        }


        
/// <summary>
        /// The SldWorks swApp variable is pre-assigned for you.
        /// </summary>
        public
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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Add Buttons to Task Pane (C#)
*Comment:  
*   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:



x

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
x

Web Help Content Version: API Help (English only) 2013 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.