API Examples*

API examples that not only show of to use various functions of the API (Application Programming Interface) but also provide useful macros for everyday use.

API examples for various functions (i.e.,.NET Framework, Add-In, Assembly, C++, Configrations, Drawings, Dimensions, Example Projects, Features, Features - COM Macro, File Operations, File Referenences, General, Geometry & Topology, Miscellaneous, OpenGL, Parts, PDMWorks, PropertyManger, Sheetmetal, Sketch, User Interface, User preferences, and Visual Basic).

Category	Description	Type
.NET Framework	How to install a .NET DLL add-in	C#
.NET Framework	How to install a .NET DLL add-in	Any
.NET Framework	How to use .NET with SOLIDWORKS	Any

API Help/SDK	SOLIDWORKS 2006 API Online Help	Any
API Help/SDK	SOLIDWORKS 2006 API SDK	Any
API Help/SDK	eDrawings 2008 API SDK	Any
API Help/SDK	eDrawings 2007 API SDK	Any

Back to top

Add-in	How to add self registration to .NET add-ins	C#
Add-in	How to create edit boxes like those in SOLIDWORKS PropertyManager pages	C++
Add-in	How to disable SOLIDWORKS memory handler	C++
Add-in	How to manage resources in ATL COM DLL add-in	C++
Add-in	How to use Third Party Storage in an Addin	Any
Add-in	How to automatically make your ATL COM DLL add-in appear in the SOLIDWORKS Add-in Manager	C++
Add-in	How to create an object with program ID VsWizardEngine	C#
Add-in	How to implement MFC support in an ATL COM DLL add-in	C++
Add-in	How to install a Visual Basic ATL COM DLL add-in	Any
Add-in	How to manage your application resources in Visual C/C++	C++
Add-in	How to see call stack in SOLIDWORKS 2001Plus and later when DLL add-in crashes	C++
Add-in	How to set up C++ COM MenuEnableMethod for SldWorks::AddToolbarCommand2 and SldWorks::AddMenuItem2	C++
Add-in	How to stop Visual Basic from generating a new CLSID when ever a COM DLL add-in is built	VB
Add-in	What happens when an MFC DLL add-in is unloaded?	C++
Add-in	Where is the Visual Basic 6.0 Resource Editor add-in?	VB

Back to top

Assembly	How to adjust the scope of assembly-level features	VB
Assembly	How to change the configuration of an assembly component to in-use or last-saved	VB
Assembly	How to check an assembly for interference	C++
Assembly	How to create a cavity in an assembly	VB
Assembly	How to determine if an assembly component is being edited in-context	VB
Assembly	How to get the parent component of an assembly component	VB
Assembly	How to implement Drag and Drop of files from a FM-TreeCtrl to SW-View	C++
Assembly	How to iterate over mates in an assembly	C++
Assembly	How to reload an assembly component from a different path	VB
Assembly	How to rename components in an assembly	VB
Assembly	How to suppress assembly rebuild dialog	VB
Assembly	How to suppress rebuild dialog when activating assembly	Any
Assembly	How to resolve Component2::IGetChildren Visual C++ compiler error	C++
Attributes	How to add an attribute to the selected entity	VB

Back to top

C++	How to get preview bitmaps	C++
C++	How to enable tab and accelerator processing in modeless ATL dialogs	C++
C++	How to pass a BSTR to ModelDocExtension::SelectByID2 in Windows 9x in an MFC DLL add-in	C++
C++	How to release COM objects during a traversal	C++
C++	When to release COM interface pointers	C++
C++	Why was a template class implemented for Variant SafeArrays?	C++
C++	How to connect to a running instance of SOLIDWORKS in a C++ Dispatch-based Executable	C++

Back to top

Configurations	How to export selected assembly component as a Parasolid file	VB
Configurations	How to get the mass properties for all configurations	VB

Documentation	How to integrate SOLIDWORKS API Help file with MSDN	Any

Drawings	How to add a hole callout to a drawing at specified location	VB
Drawings	How to align notes in drawing	VB
Drawings	How to change a drawing view to shaded	VB
Drawings	How to create a drawing of a flattened sheet metal part	VB
Drawings	How to delete all BOMs in a drawing sheet	VB
Drawings	How to delete all notes on a specified layer	VB
Drawings	How to delete the current drawing sheet	VB
Drawings	How to display a leader when inserting a note in a drawing	VB
Drawings	How to find features associated with selected edge in drawing view	VB
Drawings	How to get data for center marks that are feautures	VB
Drawings	How to insert a BOM at the selected point	VB
Drawings	How to locate a model entity in the space of a drawing view	VB
Drawings	How to move a drawing view	VB
Drawings	How to reload the drawing sheet format	VB
Drawings	How to use Microsoft Word spell checker in drawings	VB
Drawings	How to work with RapidDraft drawings	VB
Drawings	How to control the margins of a drawing during printing	VB
Drawings	How to create an empty drawing view	VB

Back to top

Dimensions	Why is the return value of a dimension is sometimes 0?	VB
Dimensions	How to move all dimensions to a different layer	VB
Dimensions	How to change position of dimension in drawing	VB

Back to top

Example Project	Retrieve SOLIDWORKS preview bitmap and display lists (2009)	C++
Example Project	Retrieve SOLIDWORKS preview bitmap and display lists (2008)	C++
Example Project	Retrieve SOLIDWORKS preview bitmap and display lists (2007)	C++
Example Project	Using Task Pane and Mouse Events	C++
Example Project	Using dispatch wrappers to pass arrays of objects to SOLIDWORKS APIs	Any
Example Project	Macro to add bend information to drawings as notes (VB)	VB
Example Project	Quick command line script to register a .net addin	.NET
Example Project	Sheet metal bend line analysis demo	VB
Example Project	Simple PDMWorks Triggers Diagnostic tool	VB
Example Project	Visual Studio 2005 VB.Net Addin Template	VB.NET
Example Project	Visual Studio 2005 C# Addin Template	C#
Example Project	Roadmap to a Custom SOLIDWORKS Feature	VB
Example Project	API Tips and Tricks (2006)	Any
Example Project	Using Property Manager Pages and Attributes to identify and store persistent data with key model elements	VB
Example Project	PDMWorks API Application Planning and Design Strategies	Any
Example Project	Create Command Manager-style API toolbars	C++
Example Project	Retrieve SOLIDWORKS preview bitmap and display lists (2006)	C++
Example Project	Implement macro feature as add-in	ATL COM
Example Project	Add menu item to SOLIDWORKS main menu	VB
Example Project	Create Quick Tips	VB.NET
Example Project	Unregister a SOLIDWORKS COM DLL	C++.NET
Example Project	SOLIDWORKS API HTML Help Cascading Style Sheets	Any
Example Project	Rename and copy SOLIDWORKS files currently in memory	VB
Example Project	Use PDMWorks API to automate PDM communication, integration, and analysis	VB
Example Project	Continuously capture images of model	VB
Example Project	Automating and customizing Bill of Materials	VB
Example Project	Turn macros into applications by assigning persistent IDs to objects	VB
Example Project	Add ActiveX control to FeatureManager design tree	VB
Example Project	Add ActiveX control for PropertyManager page	VB
Example Project	Add menu item, toolbar, and toolbar buttons	VB.NET
Example Project	Add menu item, toolbar, and toolbar buttons	ATL COM
Example Project	Extract Parasolid bodies	C++.NET
Example Project	Identify suitability of surfaces on a part for molding	VB
Example Project	Run events monitor utility	VB
Example Project	Automate production process	VB
Example Project	Create macro features in multibody part	VB
Example Project	Batch print SOLIDWORKS drawing files	VB
Example Project	Display preview bitmaps	VB
Example Project	Create PropertyManager page	VB
Example Project	Create PropertyManager page for inserting balloons	VB
Example Project	Implement macro feature	ATL COM
Example Project	Retrieve SOLIDWORKS preview bitmap and display lists	C++
Example Project	Add ActiveX control to manage equations	VB
Example Project	Add ActiveX control to manage density of a part	VB
Example Project	Add ActiveX control to control custom properties	VB
Example Project	Create Visual Basic TreeView of assembly components	VB
Example Project	Extract preview bitmaps	C++ VB
Example Project	Run notifications utility	VB
Example Project	Add menu item and add corresponding toolbar and toolbar buttons	VB
Example Project	Automate creation of PropertyManager Page, menu item, use of SOLIDWORKS math library objects, and following a curve	VB
Example Project	Automate interaction with Microsoft Excel, configurations in SOLIDWORKS documents, and creation of SOLIDWORKS drawings	VB
Example Project	Use boundary representation (BREP) data	VB
Example Project	Extract eDrawings data from a SOLIDWORKS file	C++ VB
Example Project	Extract Parasolid bodies	C++ VB
Example Project	Draw into OpenGL context	C++

Back to top

Events/Notifications	How to tell if a part is being saved as a copy	C++

Features	How to access information in hole generated by Hole Wizard	VB
Features	How to change the surfaces or faces of a surface knit feature	VB
Features	How to check all fillets and select those below a minimum value	VB
Features	How to delete all suppressed features and sub-features in a part	VB
Features	How to determine if a feature is in a folder	VB
Features	How to get reference plane data	VB
Features	How to get the parent and child relationship for a feature	VB
Features	How to insert a Hole Wizard hole feature	VB
Features	How to remove a body from the feature scope of a cut feature	VB
Features	How to select which bodies to keep for a feature that generates multiple bodies	VB
Features	How to suppress the features of selected items	VB
Features	How to turn off lights in model	VB

Back to top

Features - COM/Macro	How to create springs using a macro feature	VB
Features - COM/Macro	How to insert a macro feature	VB

File Operations	How to access custom properties without having SOLIDWORKS installed	VB
File Operations	How to close all open files and save all changes	VB
File Operations	How to close all open files without saving any changes	VB
File Operations	How to export to JPG format	VB
File Operations	How to get supported paper sizes for a printer	VB
File Operations	How to save current file as a STEP AP213 (European) in the same directory	VB
File Operations	How to save current file as ACIS in same directory	VB
File Operations	How to save current file as an eDrawings file in the same directory	VB
File Operations	How to save current file as IGES in same directory	VB
File Operations	How to save current file as STL in same directory	VB
File Operations	How to load PDF export filter	Any

Back to top

File References	How to recursively lock and unlock all external references in a part or assembly	VB
File References	What SOLIDWORKS APIs are related to PDM reference management?	VB

General	Is there an API for SOLIDWORKS Viewer?	Any
General	Is there an API for eDrawings?	Any
General	How to resolve missing reference error message in a SOLIDWORKS macro	VB
General	API for SOLIDWORKS Educational and Personal Editions	Any
General	How to find out where recent versions of SOLIDWORKS are installed	Any
General	How to find out where SOLIDWORKS is installed on a computer	Any
General	How to prevent memory leaks in arrays of COM interface pointers	C++
General	Is there an API for SOLIDWORKS Explorer?	Any
General	Is Visual C++ faster than Visual Basic?	Any
General	What is the life span of an API object?	Any
General	What units are required and returned by API functions?	Any
General	Where to get the type library for SOLIDWORKS API	Any

Back to top

Geometry & Topology	How to calculate the surface area of a model, including reference surfaces	VB
Geometry & Topology	How to create a loft	VB
Geometry & Topology	How to create a temporary body from a cylinder	VB
Geometry & Topology	How to create curve on surface	VB
Geometry & Topology	How to extract curve information for text in a sketch	VB
Geometry & Topology	How to get parameters of curve	C++
Geometry & Topology	How to get silhouette edges for a face	C++
Geometry & Topology	How to get silhouette edges of a model	VB
Geometry & Topology	How to get the bodies generated by a feature	VB
Geometry & Topology	How to get the centers and directions of Hole Wizard holes	VB
Geometry & Topology	How to get the curve parameterization for the selected edge	VB
Geometry & Topology	How to get the distance between two parallel faces	VB
Geometry & Topology	How to get the minimal bounding box of a part for packaging purposes	VB
Geometry & Topology	How to get the number of display facets	VB
Geometry & Topology	How to get the perimeter length of a selected face	VB
Geometry & Topology	How to get the surface parameterization for the selected face	VB
Geometry & Topology	How to get trim curve data from a face	VB
Geometry & Topology	How to measure the thickness of a part	VB
Geometry & Topology	How to obtain spline and surface data to create a reference surface	VB
Geometry & Topology	How to replace the surface of a face	VB
Geometry & Topology	How to use a processed body	VB
Geometry & Topology	How to use the Tessellation object	VB
Geometry & Topology	What API objects supersede the math helper functions in SOLIDWORKS 2001Plus and later?	C++

Back to top

Miscellaneous	How to determine numerical values for the SOLIDWORKS version	VB
Miscellaneous	How to determine the current language in SOLIDWORKS is running	VB
Miscellaneous	How to get all spot light properties	VB
Miscellaneous	New APIs for SOLIDWORKS 2003	Any

OpenGL	How SOLIDWORKS Xform relates to OpenGL transformation matrix	C++
OpenGL	How to detect selection of a add-in drawn OpenGL object	C++

Part	How to add a row to a design table	VB
Part	How to export to Parasolid transmit format	VB
Part	How to get the structured storage area associated with a configuration	VB

PDMWorks	How to check in documents, change projects, change owners, and use other APIs new to PDMWorks 2005	VB
PDMWorks	How to search for a custom property in a PDMWorks vault	VB
PDMWorks	How is PDMWorks API licensed?	Any

Back to top

PropertyManager	How to place control on PropertyManager page	C#

Sheet Metal	How to insert sheet metal edge flange	VB

Sketch	How to change all sketches to fully constrained	VB
Sketch	How to determine is a sketch is suitable for use in a feature	VB
Sketch	How to get all sketch segment types and data	VB
Sketch	How to get the length of a sketch segment	VB
Sketch	How to get the persistent IDs for sketch points and sketch segments	VB
Sketch	How to get the text formatting for sketch text	VB
Sketch	How to insert a sketch with an automatic normal to	VB
Sketch	How to split a sketch segment into a number of equal portions	VB

Back to top

User Interface	How to create PropertyManager page	VB
User Interface	How to get the colors of a part	VB
User Interface	How to set status bar text	VB
User Interface	How to use callouts	VB

User Preferences	How to determine which user preference has changed	VB

Back to top

Visual Basic	How to determine if a Variant returned from an API call has valid data	VB
Visual Basic	How to create and edit bitmaps in Visual Basic 6.0	VB
Visual Basic	How to pass SafeArrays in Visual Basic 6.0	VB
Visual Basic	How to tell if a SOLIDWORKS session is already running	VB
Visual Basic	How to unpack integers from double arrays in Visual Basic 6.0	VB
Visual Basic	How to use the Object Browser in Visual Basic 6.0 to see SOLIDWORKS API methods and properties	VB

Back to top