Hymma.Solidworks

A collection of .NET libraries for building SolidWorks add-ins and extensions.

Packages

Package	Description	NuGet
Hymma.Solidworks.Interop	SolidWorks Interop library references
Hymma.Solidworks.Extensions	Extension methods for SolidWorks API
Hymma.Solidworks.Addins	Framework for native-looking SolidWorks add-ins
Hymma.Solidworks.Addins.Fluent	Fluent API wrapper for building add-ins

Quick Start

Installation

# For the fluent API (recommended)
Install-Package Hymma.Solidworks.Addins.Fluent

# Or for the base add-in framework
Install-Package Hymma.Solidworks.Addins

# For extension methods only
Install-Package Hymma.Solidworks.Extensions

Using Addins.Fluent (Recommended)

using Hymma.Solidworks.Addins.Fluent;
using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using System.Runtime.InteropServices;

[Guid("YOUR-GUID-HERE")]
[ComVisible(true)]
public class MyAddin : AddinMaker
{
    public override AddinUserInterface GetUserInterFace()
    {
        return new AddinUserInterface(this)
            .AddCommandTab()
                .WithTitle("My Tab")
                .That()
                .IsVisibleIn(swDocumentTypes_e.swDocPART, swDocumentTypes_e.swDocASSEMBLY)
                .AddCommandGroup()
                    .WithTitle("My Commands")
                    .WithIcon(Resources.MyIcon)
                    .Has()
                    .Commands(cmds => cmds
                        .Command("Do Something")
                            .WithIcon(Resources.CommandIcon)
                            .OnClick(() => DoSomething())
                        .Command("Another Action")
                            .WithIcon(Resources.AnotherIcon)
                            .OnClick(() => AnotherAction()))
                    .SaveCommandGroup()
                .SaveCommandTab();
    }

    private void DoSomething()
    {
        // Your code here
    }

    private void AnotherAction()
    {
        // Your code here
    }
}

Using Addins (Base Framework)

using Hymma.Solidworks.Addins;
using SolidWorks.Interop.sldworks;
using System.Runtime.InteropServices;

[Guid("YOUR-GUID-HERE")]
[ComVisible(true)]
public class MyAddin : AddinBase
{
    public override bool OnConnect()
    {
        // Initialize your add-in
        return true;
    }

    public override bool OnDisconnect()
    {
        // Clean up resources
        return true;
    }
}

Compatibility

SolidWorks Version	.NET Framework	Status
2021+	4.8	✅ Supported
2019-2020	4.7.2+	✅ Supported
2018	4.6.2+	✅ Supported
2017 and earlier	4.5.2+	⚠️ May work, not tested

Note: SolidWorks add-ins require .NET Framework (not .NET Core/.NET 5+) due to COM interop requirements.

Sample Add-ins

This repo includes two sample add-ins to help you get started:

• QRify - Built with Hymma.Solidworks.Addins

  • Converts text to QR code and copies to clipboard

• QRify+ - Built with Hymma.Solidworks.Addins.Fluent

  • Converts custom property values to QR codes with suffix support

Both samples are free for commercial use and include .snk files for immediate building after cloning.

Context Menus

SolidWorks context menus are the right-click menus that appear for specific selection types (features, faces, edges, sketch segments, etc.). The helper API in Hymma.Solidworks.Addins lets you register your own items for those selection types and wire callbacks with selection-based predicates.

Quick Example

using Hymma.Solidworks.Addins.ContextMenus;

var registrar = ContextMenuRegistrar.Create(this, e.Cookie);
var menu = new ContextMenuDefinition(
    "My Feature Menu",
    new[] { ContextMenuTarget.Features },
    new[]
    {
        new ContextMenuItem(
            "Inspect Feature",
            ctx => { /* handle click */ },
            ctx => ctx.SelectionCount > 0)
    });

registrar.Register(menu);

See examples/context-menus/README.md for two full examples (features + sketch segments).

Limitations

• You cannot modify built-in SolidWorks menu items; you can only add your own.
• Context menu callbacks must be registered after the add-in has access to ICommandManager.
• Context menus are selection-type specific; the right selection must exist before right-click.

Best Practices

• Register context menus during add-in connect (OnStart) and dispose them on disconnect (OnExit).
• Keep predicates fast and avoid heavy work on the UI thread.
• Use selection-based predicates to enable/disable menu items rather than doing work in callbacks.

Context Menu Not Showing?

• Confirm registration happens after ICommandManager is available.
• Verify the selection type matches (feature vs face vs edge, etc.).
• Ensure your add-in is loaded and not disabled.
• Check for command ID/callback mismatches and duplicate registrations.
• Ensure you are targeting x64 if SolidWorks is x64.
• Ensure something is selected before right-clicking.

Documentation

• Addins Framework Guide
• Fluent API Guide
• API Documentation
• Changelog

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

MIT © 2021 HYMMA