Hide Table of Contents

Context-Sensitive SOLIDWORKS API Help

Context-sensitive SOLIDWORKS API help is available as you edit SOLIDWORKS VBA and .NET macros.

To see context-sensitive SOLIDWORKS API help:

  1. Select a SOLIDWORKS API (interface, method, property, or enumerator) in the editor (VBA or VSTA or Visual Studio).
  2. Press F1.

As of SOLIDWORKS 2018, if you have Visual Studio 2015 installed, context-sensitive API help for .NET displays in the Microsoft Help Viewer. When you install SOLIDWORKS 2018 or later, SOLIDWORKS API and enumerator helps are registered and integrated with the Help Viewer catalogs of the Visual Studio installed on your machine. After installing SOLIDWORKS 2018, configure Visual Studio to launch Help Viewer help by selecting Help >  Help Preference > Launch in Help Viewer.

Please note:

  • Help Viewer SOLIDWORKS API help (*.cab and *.msha) for users of Visual Studio 2012, 2013, or 2015 is delivered in install_dir/api/HelpViewer.
  • HTML 2.0 compiled SOLIDWORKS API help for users of VSTA and Visual Studio versions earlier than 2015 is delivered in install_dir/api/HTMLHelp2x.
  • HTML 1.0 compiled SOLIDWORKS API help for users of VBA is delivered in install_dir/api.

When you press F1 while editing:

  • VBA macros, HTML 1.0 compiled help displays.
  • VB.NET and C# macros in VSTA 1.0, HTML 2.0 compiled help displays.
  • VB.NET and C# programs in Visual Studio (2012, 2013), either Help Viewer help or HTML 2.0 compiled help displays. Configure Visual Studio to launch either the Help Viewer or a browser before using F1.
  • VB.NET and C# programs in Visual Studio 2015, only Help Viewer help can display. You must configure Visual Studio 2015 to launch the Help Viewer before using F1.
  • VB.NET and C# macros or programs in Visual Studio 2015, example links in the displayed help do not work. You must open local help to see examples.

If after installing SOLIDWORKS, F1 does not display help for SOLIDWORKS APIs in .NET macros, try manually registering the SOLIDWORKS API Help with Help Viewer.

If a previous version of the context-sensitive help is already installed, you must remove it before installing another version. To remove SOLIDWORKS API Help from the Help Viewer:

  1. In Visual Studio, select Help >  Set Help Preference > Launch in Help Viewer.
  2. Select Help > View Help.
  3. Click the Manage Content tab.
  4. In the Action column for the SOLIDWORKS API Help row, click Remove.
  5. Click Update at the bottom of the Manage Content tab.

To register SOLIDWORKS API help with Visual Studio Help Viewer:

  1. In Visual Studio, select Help >  Set Help Preference > Launch in Help Viewer.
  2. Select Help > View Help.
  3. Click the Manage Content tab.
  4. Select Disk
  5. Select the location of source content by clicking ... .
  6. Navigate to and select install_dir\api\HelpViewer\sldworksapi\helpcontentsetup.msha.
  7. Click Open.
  8. In the Action column for the SOLIDWORKS API Help row, click Add.
  9. Click Update at the bottom of the Manage Content tab.
  10. Click OK in the Security dialog box.

To register SOLIDWORKS API enumerator help with Visual Studio Help Viewer:

  1. In Visual Studio, select Help >  Set Help Preference > Launch in Help Viewer.
  2. Select Help > View Help.
  3. Click the Manage Content tab.
  4. Select Disk
  5. Select the location of source content by clicking ... .
  6. Navigate to and select install_dir\api\HelpViewer\swconst\helpcontentsetup.msha.
  7. Click Open.
  8. In the Action column for the SOLIDWORKS API Help row, click Add.
  9. Click Update at the bottom of the Manage Content tab.
  10. Click OK in the Security dialog box.



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:   Context-Sensitive SOLIDWORKS API Help
*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) 2021 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.