SolidWorks API SolidWorks API DemystifiedDemystified

Leonard KikstraLeonard KikstraDesigner / CAD AdministratorDesigner / CAD AdministratorRITE-HITE Products CorporationRITE-HITE Products CorporationMilwaukee, WIMilwaukee, WI

Lenny’s SolidWorks ResourcesLenny’s SolidWorks Resourceshttp://www.lennyworks.com/solidworkshttp://www.lennyworks.com/solidworks

Who am I?Who am I?

Product DesignerProduct Designer– Engineering since 1982.Engineering since 1982.– Cad user since 1991.Cad user since 1991.– SolidWorks user since SolidWorks user since

1998.1998.

CAD AdministratorCAD Administrator– 20+ people on site.20+ people on site.– Advise other sites.Advise other sites.

Interested in simplifying Interested in simplifying my job.my job.– Make my computer do Make my computer do

some of my work for me.some of my work for me.

SMART User GroupSMART User Group– Active member since Active member since

group started in 1999.group started in 1999.

Lenny’s SolidWorks Lenny’s SolidWorks Resources website.Resources website.– Online Sept. 2003. Online Sept. 2003. – New home Sept. 2006.New home Sept. 2006.

Programmed over 30 Programmed over 30 macros for use in macros for use in SolidWorksSolidWorks– Most of these are Most of these are

available for free on available for free on the Internet.the Internet.

What is covered here.What is covered here.

General InformationGeneral Information– What is the SolidWorks API?What is the SolidWorks API?– Benefits of learning/using the API.Benefits of learning/using the API.

Getting Started.Getting Started.– Create and modify macros.Create and modify macros.– Finding your way.Finding your way.– When and Why.When and Why.

Program examplesProgram examples– JustificationJustification

Where to get help.Where to get help.

What is the SolidWorks What is the SolidWorks API?API?

Application Programming Interface.Application Programming Interface.– Allows other programs to access SolidWorks data and/or Allows other programs to access SolidWorks data and/or

control SolidWorks.control SolidWorks.– Examples: SolidWorks Add-InsExamples: SolidWorks Add-Ins

Cosmos, Toolbox, PhotoWorks, PDM Works, PDM Works Cosmos, Toolbox, PhotoWorks, PDM Works, PDM Works EnterpriseEnterprise

Why?Why?– Allow third party vendors to build applications that Allow third party vendors to build applications that

access SolidWorks and SolidWorks data.access SolidWorks and SolidWorks data.– Lets SolidWorks focus on their core products.Lets SolidWorks focus on their core products.

SolidWorks Add-Ins have API’s.SolidWorks Add-Ins have API’s.eDrawingseDrawings SolidWorks ToolBoxSolidWorks ToolBoxFeatureWorksFeatureWorks SolidWorks UtilitiesSolidWorks UtilitiesPDMWorksPDMWorks SolidWorks RoutingSolidWorks RoutingPhotoWorksPhotoWorks

How can the API benefit How can the API benefit you?you?

Automate common and repetitive tasks.Automate common and repetitive tasks.– Increase productivity.Increase productivity.– Save time and money.Save time and money.– Standardize procedures.Standardize procedures.

Consistently retrieve or export data that Consistently retrieve or export data that already exists in the SolidWorks already exists in the SolidWorks documents.documents.

Develop useful tools to meet your Develop useful tools to meet your specific needs.specific needs.

Customize SolidWorks.Customize SolidWorks.– Add commands, change settings, etc…Add commands, change settings, etc…

Access the SolidWorks Access the SolidWorks APIAPI

Stand alone application Stand alone application ExecutableExecutable– Visual C++ .NetVisual C++ .Net Visual Basic .Net. Visual Basic .Net.

Visual C++Visual C++ Visual BasicVisual BasicVisual CVisual C

Programming environment outside of Programming environment outside of SolidWorks.SolidWorks.

Must be compiled to use outside of Must be compiled to use outside of programming environment.programming environment.

– Can start SolidWorks.Can start SolidWorks.– Required for creating Add-Ins/DLL’s.Required for creating Add-Ins/DLL’s.

SolidWorks MacroSolidWorks Macro .swp file.swp file– Microsoft Visual Basic for Applications.Microsoft Visual Basic for Applications.

SolidWorks Program (.swp) is a single file.SolidWorks Program (.swp) is a single file. Must be launched from within SolidWorks.Must be launched from within SolidWorks. Installed with SolidWorks.Installed with SolidWorks. No compilingNo compiling Some limitations.Some limitations.

SolidWorks MacrosSolidWorks Macros

The macro recorder.The macro recorder.– Start recorder.Start recorder.– Complete tasks.Complete tasks.– Some settings in dialog boxes are not Some settings in dialog boxes are not

recorded.recorded.– Pause if needed.Pause if needed.– Stop recorder and save new macro.Stop recorder and save new macro.

Running a macroRunning a macro– Run MacroRun Macro– Select macroSelect macro– Macro will automatically runMacro will automatically run

Stop Record / Pause

Run

SolidWorks MacrosSolidWorks Macros

Edit macro.Edit macro.– Select macro.Select macro.– Visual Basic Editor automatically launched.Visual Basic Editor automatically launched.– Make changes.Make changes.– Test MacroTest Macro– F5 to run macroF5 to run macro– F8 to step thru the macro line by lineF8 to step thru the macro line by line– Save macro.Save macro.– Exit Visual Basic editor.Exit Visual Basic editor.

New MacroNew Macro– Create a new macro without using macro recorder.Create a new macro without using macro recorder.– Enter macro nameEnter macro name– Visual Basic Editor automatically launched.Visual Basic Editor automatically launched.

Edit Macro

New Macro

Visual Basic Editor: Visual Basic Editor: EnvironmentEnvironment

Project:Project:– SolidWorks Objects.SolidWorks Objects.– Definitions of SolidWorks Definitions of SolidWorks

Objects.Objects.

Forms.Forms.– Object based interface for Object based interface for

user interaction.user interaction.– Custom code programmed for Custom code programmed for

each object in form.each object in form.

Modules.Modules.– Modules that only contain Modules that only contain

code for the macro.code for the macro.– Common modules used in Common modules used in

many macros.many macros.

Visual Basic Editor: Visual Basic Editor: ReferencesReferences

Access via “Tools | Access via “Tools | References” menu References” menu selections in the VB Editor. selections in the VB Editor.

Attach objects from another Attach objects from another application to your project.application to your project.– Standard descriptions of Standard descriptions of

object types, properties object types, properties and methods.and methods.

Selections are specific to Selections are specific to each macro. each macro.

SolidWorks Type Libraries SolidWorks Type Libraries are version specific.are version specific.

Writing a macro: Writing a macro: VariablesVariables

LocalLocal– Value retained only while in module or procedure where Value retained only while in module or procedure where

defined.defined.– Value can changeValue can change– Same variable name can be defined locally in multiple Same variable name can be defined locally in multiple

modules.modules.

GlobalGlobal– Value retained through out all modules and procedures.Value retained through out all modules and procedures.– Value can changeValue can change– Can be used set fixed values for common reference later.Can be used set fixed values for common reference later.

Pi = 4 * Atn(1) ' The infamous pi valuePi = 4 * Atn(1) ' The infamous pi value

ConstantsConstants– Assign a specific value to variable name.Assign a specific value to variable name.– Set onceSet once– CAN NOT be changedCAN NOT be changed– CAN NOT use formula to defineCAN NOT use formula to define

Writing a macro: Writing a macro: Variable TypesVariable Types

BooleanBoolean - True or False- True or False

IntegerInteger - Whole numbers only- Whole numbers only

LongLong - Any numerical value- Any numerical value

StringString - Any text based value- Any text based value

VariantVariant - Can be any type- Can be any type

Array()Array() - Spreadsheet of data- Spreadsheet of data

VariantArray()VariantArray() - Spreadsheet of data of any type.- Spreadsheet of data of any type.

Writing a macro: Writing a macro: ObjectsObjects

Must name an object to access it’s propertiesMust name an object to access it’s properties– Meta-data Meta-data - Info about object- Info about object– Features Features - Sub-objects- Sub-objects

Multiple tiersMultiple tiers– Parent – Child relationshipsParent – Child relationships

MethodsMethods Command and syntax that provides access to object’s Command and syntax that provides access to object’s

propertiesproperties

AccessorsAccessors Roadmap that shows how to get to object.Roadmap that shows how to get to object. Command and syntax how to get to object from parent.Command and syntax how to get to object from parent.

ModelDoc2ModelDoc2

SolidWorksSolidWorks

Writing a macro:Writing a macro:RoutinesRoutines

Sub (Procedures)Sub (Procedures)– PrivatePrivate - Can only access - Can only access

from module it resides infrom module it resides in– PublicPublic - Can be accesses - Can be accesses

from any modulefrom any module– Run from top-down until Run from top-down until

completedcompleted– Can be access many times.Can be access many times.– Can launch other routines.Can launch other routines.– Can pass variables between Can pass variables between

routines.routines.

Function – Special Function – Special ProcedureProcedure– Must pass a variable to Must pass a variable to

FunctionFunction– Returns a value to variable Returns a value to variable

in the calling procedure.in the calling procedure.

Writing a macro:Writing a macro:Testing and RunningTesting and Running

Testing macro or procedureTesting macro or procedure– F5F5 Run macroRun macro– F8F8 Step thru codeStep thru code

line-by-line.line-by-line.– Start in current procedure.Start in current procedure.

Automatic starting pointAutomatic starting point– Last procedure, in last inserted Last procedure, in last inserted

modulemodule– Not module name specific.Not module name specific.– Not procedure name specific.Not procedure name specific.

Writing a macro:Writing a macro:Typical Steps - LaunchTypical Steps - Launch

Launch MacroLaunch Macro– Load type librariesLoad type libraries– Set global variables and Set global variables and

constantsconstants– Attach to SolidWorksAttach to SolidWorks

Is a document open in Is a document open in SolidWorks?SolidWorks?– No, warn user that you No, warn user that you

need one, then end.need one, then end.

Get document type.Get document type.– Wrong type, warn user and Wrong type, warn user and

endend

Proceed……………Proceed……………

Writing a macro:Writing a macro:Typical Steps - User Typical Steps - User FormForm

User formUser form– Preprocessing.Preprocessing.

Set program defaults.Set program defaults. Read data from document.Read data from document.

– Display user form to user.Display user form to user.

Wait for inputWait for input– React to user input.React to user input.

Read more data from Read more data from document.document.

Update user form.Update user form. Update document.Update document.

– Action buttonsAction buttons OK / ProcessOK / Process CancelCancel HelpHelp OtherOther

Writing a macro:Writing a macro:Typical Steps - Typical Steps - ProcessingProcessing

Process user requests based Process user requests based on form values.on form values.

Inform user of status during Inform user of status during processing.processing.

Inform user of errors Inform user of errors encountered.encountered.

Inform user of status upon Inform user of status upon completion.completion.– Wait for user OK.Wait for user OK.

Writing a macro:Writing a macro:Typical Steps - Typical Steps - CompletionCompletion

Close formsClose forms

Clear out objects and Clear out objects and variables.variables.

Close macroClose macro

Macro Feature:Macro Feature:

Embed macro as a feature in the model.Embed macro as a feature in the model.

Overview of Macro FeatureOverview of Macro Feature– See SolidWorks API Help FileSee SolidWorks API Help File

Assigning a macro to a Assigning a macro to a Toolbar Button.Toolbar Button.

Must have document open in Must have document open in SolidWorksSolidWorks

How To:How To:– Rt. Click toolbar, CustomizeRt. Click toolbar, Customize– Commands tab, Category: MacroCommands tab, Category: Macro– Drag icon and drop on toolbar.Drag icon and drop on toolbar.– Select an image to use on Select an image to use on

toolbar.toolbar.– Fill out fields in dialog box:Fill out fields in dialog box:

Tooltip Tooltip - Balloon tip at - Balloon tip at arrow.arrow.

Prompt Prompt - Help info in - Help info in status bar.status bar.

MacroMacro - Name and full - Name and full path.path.

MethodMethod - Module and - Module and procedure.procedure.

ShortcutShortcut - Key combo to - Key combo to launch macro.launch macro.

– Click OK to completeClick OK to complete

When should I write my When should I write my own macro?own macro?

Consistent retrieval & exporting of data.Consistent retrieval & exporting of data.– Remove manual tasks and retyping errors.Remove manual tasks and retyping errors.– Consistent results with consistent Consistent results with consistent

formatting.formatting.– Examples:Examples:

Retrieve and export a BOM from the Retrieve and export a BOM from the assemblyassembly

– No drawing required.No drawing required. Create a list of all components in a directory.Create a list of all components in a directory.

Automating common or repetitive tasks.Automating common or repetitive tasks.– Save valuable time and money.Save valuable time and money.– Examples:Examples:

Exports SolidWorks documents to different Exports SolidWorks documents to different file types.file types.

Print all drawings in the current directory.Print all drawings in the current directory. Print all drawings for all components in a Print all drawings for all components in a

current assembly.current assembly. Retrieve and export a BOM for multiple Retrieve and export a BOM for multiple

configurations.configurations.

When should I write my When should I write my own macro?own macro?

Enforce compliance with standard Enforce compliance with standard procedures.procedures.– Provide an automated method to follow Provide an automated method to follow

standards.standards.– Consistent document appearance.Consistent document appearance.– Examples:Examples:

Preset SolidWorks settings to your company Preset SolidWorks settings to your company standards.standards.

Set annotations in document to use document Set annotations in document to use document defaults.defaults.

Copy document settings from “master” Copy document settings from “master” document to current document.document to current document.

Simplifies adding standardized notes to Simplifies adding standardized notes to drawings.drawings.

Need a special tool to automate a specific Need a special tool to automate a specific task.task.

Justification to write a Justification to write a macro:macro:

Define your needs.Define your needs.– What is the purpose of macro?What is the purpose of macro?– How often will you use it?How often will you use it?

The more you use it, the more time The more you use it, the more time you will saveyou will save

Does it already exist?Does it already exist?– Is there something available that’s Is there something available that’s

close to what I need?close to what I need?– Can I modify something I already Can I modify something I already

have? have? – Examples files:Examples files:

Help fileHelp file SolidWorks WebsiteSolidWorks Website Lenny’s SolidWorks ResourcesLenny’s SolidWorks Resources

Justification to write a Justification to write a macro:macro:

Example #1 - New Macro - Document ExportExample #1 - New Macro - Document Export– Scope:Scope: * Export documents to different file types.* Export documents to different file types.

* Drawings, Models, Configurations* Drawings, Models, Configurations* 20 models to create 300 exported * 20 models to create 300 exported

filesfiles

– Problems via manual way - Manual process, Repetitive, Problems via manual way - Manual process, Repetitive, Time consuming, user input required at all steps!Time consuming, user input required at all steps!

Did I export all configurations?Did I export all configurations? Selecting file type by hand every time.Selecting file type by hand every time. Consistent configuration naming.Consistent configuration naming. Estimate time to complete:Estimate time to complete: 12-14 Hours12-14 Hours

– Time comparison:Time comparison: Time to write:Time to write: 8 Hours8 Hours Automated:Automated: 1.5 Hours1.5 Hours Saved first use:Saved first use: 10-12 Hours10-12 Hours

– Macro can be reused many, many times.Macro can be reused many, many times.

Justification to write a Justification to write a macro:macro:

Example #1 – Modify Macro – Change custom property Example #1 – Modify Macro – Change custom property value.value.– Scope:Scope: * All documents require change, addition or * All documents require change, addition or

removal of a custom property.removal of a custom property.* 1000’s of files.* 1000’s of files.* Found macro on internet, can modify for use.* Found macro on internet, can modify for use.

– Problems via manual way - Manual process, Repetitive, Time Problems via manual way - Manual process, Repetitive, Time consuming, user input required at all steps!consuming, user input required at all steps!

Did I change all documents?Did I change all documents? Did I make the right changes?Did I make the right changes? Estimate time to complete:Estimate time to complete: 20+ Hours20+ Hours

– Time comparison:Time comparison: Time to modify macro:Time to modify macro: 15 Minutes15 Minutes Automated:Automated: 2.5 Hours2.5 Hours Saved first use:Saved first use: 17+ Hours17+ Hours

– Macro can be customized and reused many, many times.Macro can be customized and reused many, many times.

Tips: LearningTips: Learning

Learn by example.Learn by example.– Find a good macro, and study how it works.Find a good macro, and study how it works.– Use [F8] in VB Editor to step thru code line-by-line.Use [F8] in VB Editor to step thru code line-by-line.

ExperimentExperiment– Write “do nothing” macros for Visual Basic or SolidWorks Write “do nothing” macros for Visual Basic or SolidWorks

APIAPI Learn functions you haven’t used before.Learn functions you haven’t used before. Develop your own functions or common routines.Develop your own functions or common routines. Test “What If” scenarios.Test “What If” scenarios.

– Save your code for later use.Save your code for later use.

Start small and work your way up.Start small and work your way up.– Write and test small portions of code before continuing Write and test small portions of code before continuing

to larger portions.to larger portions.– Start with a “basic” program, then add more Start with a “basic” program, then add more

functionality and flexibility later.functionality and flexibility later.

Tips: Sample CodeTips: Sample Code

Add comments to your codeAdd comments to your code– Helps you and others understand what you did, and why.Helps you and others understand what you did, and why.– Helps you remember what you did.Helps you remember what you did.– Identify what routines are doing.Identify what routines are doing.

Use existing codeUse existing code– Don’t re-invent the wheel.Don’t re-invent the wheel.– Saves time and your effort.Saves time and your effort.– Keep sample code on hand for later use.Keep sample code on hand for later use.

Know that there are multiple ways to complete tasks.Know that there are multiple ways to complete tasks.– Conditional statementsConditional statements

If … Then, Else, End IfIf … Then, Else, End If - True/False- True/False Select Case …., End CaseSelect Case …., End Case - Response based on - Response based on

value.value. For …. NextFor …. Next - Set number of times to - Set number of times to

do.do. Do While …. End LoopDo While …. End Loop - Don’t know how many - Don’t know how many

times.times.

Tips: DistributionTips: Distribution

Think about other people who may be using your Think about other people who may be using your macros.macros.

Used for other needs than initially intended.Used for other needs than initially intended.

User customization of existing macro.User customization of existing macro.– Not ever user will know how to modify your macro.Not ever user will know how to modify your macro.– External settings file for modifiable default settings.External settings file for modifiable default settings.

Macro defaults if settings file is not found.Macro defaults if settings file is not found.

Different companies have standards, procedures and Different companies have standards, procedures and needs.needs.

Capable of running on different versions of SolidWorksCapable of running on different versions of SolidWorks– API can check what version of SolidWorks is in use.API can check what version of SolidWorks is in use.

Tips: Getting HelpTips: Getting Help

SolidWorks API Help FileSolidWorks API Help File

Help forums.Help forums.

SolidWorks API Support.SolidWorks API Support.– SolidWorks API functionality only.SolidWorks API functionality only.

Be specific!Be specific!– Repeatable problem.Repeatable problem.

Steps leading up to problemSteps leading up to problem– Specific conditions lead to problemSpecific conditions lead to problem

Identify specific conditions.Identify specific conditions.– Identify specific problem you are experiencing.Identify specific problem you are experiencing.– Don’t send complete macro. Provide simple code to Don’t send complete macro. Provide simple code to

demonstrate.demonstrate.

Don’t expect help with programming techniques.Don’t expect help with programming techniques.

Resources for learning Resources for learning more:more:

Installed with SolidWorksInstalled with SolidWorks

– SolidWorks APISolidWorks API Application Programming InterfaceApplication Programming Interface

– SolidWorks API and Add-Ins help fileSolidWorks API and Add-Ins help file Explains object structure and command syntax.Explains object structure and command syntax. Many ready to use examples.Many ready to use examples. Best help file I have seen for writing macros.Best help file I have seen for writing macros.

– Visual Basic for Applications version 6 Visual Basic for Applications version 6 SolidWorks 2001Plus and laterSolidWorks 2001Plus and later Visual Basic for Applications Help File.Visual Basic for Applications Help File.

– Online Tutorial - SolidWorks APIOnline Tutorial - SolidWorks API Record, Save, Edit a macro.Record, Save, Edit a macro.

Resources for learning Resources for learning more?more?

SolidWorks web site:SolidWorks web site:

– API programming tips and updated help files.API programming tips and updated help files.

– SolidWorks Express Newsletter - API ExamplesSolidWorks Express Newsletter - API Examples

– Download projects, sample programs and macros.Download projects, sample programs and macros.

– SolidWorks Developer Kit. SolidWorks Developer Kit. Not requiredNot required Contains working sample programs.Contains working sample programs.

– PresentationsPresentations

Local VAR / SolidWorks ResellerLocal VAR / SolidWorks Reseller

– SolidWorks API Training classesSolidWorks API Training classes

Resources for learning Resources for learning more?more?Other Websites - APIOther Websites - API

Lenny’s SolidWorks ResourcesLenny’s SolidWorks Resources Macros & Macros & TipsTips– http://www.lennyworks.com/solidworkshttp://www.lennyworks.com/solidworks

Mike Wilson’s SolidWorks Modeling TechniquesMike Wilson’s SolidWorks Modeling TechniquesMacro FeatureMacro Feature– http://www.mikejwilson.com/solidworks/solidworks_files.htmhttp://www.mikejwilson.com/solidworks/solidworks_files.htm

Matt LombardMatt Lombard MacrosMacros– http://mysite.verizon.net/mjlombard/http://mysite.verizon.net/mjlombard/

Joe Jones at New Hampshire CADJoe Jones at New Hampshire CAD TutorialsTutorials– http://www.nhcad.com/sw_macros/index.htmlhttp://www.nhcad.com/sw_macros/index.html

Stefan Berlitz’s SolidWorks ToolsStefan Berlitz’s SolidWorks Tools MacrosMacros– http://www.swtools.de website.http://www.swtools.de website.

SolidWorks Tips & ThingsSolidWorks Tips & Things API TipsAPI Tips– http://www.solidworktips.com/http://www.solidworktips.com/

Resources for learning Resources for learning more?more?Visual BasicVisual Basic

Websites Websites – ““Tutorial” and “Lessons”Tutorial” and “Lessons”– May be Visual Basic Specific.May be Visual Basic Specific.– Do not provide help with specific applications.Do not provide help with specific applications.

ForumsForums– May be Visual Basic Specific.May be Visual Basic Specific.– Do not be able to provide help with specific Do not be able to provide help with specific

applications.applications.

Too many to list.Too many to list.

Some provide better explanation and examples.Some provide better explanation and examples.

SolidWorks API SolidWorks API DemystifiedDemystified

Thank You!Thank You!

Lenny’s SolidWorks ResourcesLenny’s SolidWorks Resourceshas moved tohas moved to

http://www.LennyWorks.com/solidworkshttp://www.LennyWorks.com/solidworks