跳到主要内容

使用API创建SOLIDWORKS的VB.NET插件

  • 在Microsoft Visual Studio中创建新项目
  • Visual Basic模板下选择类库模板。指定项目的位置和名称

在Visual Studio中创建VB.NET项目中的新类型库{ width=550 }

  • 添加对SolidWorks Interop库的引用:SolidWorks.Interop.sldworks.dll、SolidWorks.Interop.swconst.dll、SolidWorks.Interop.swpublished.dll。Interop库位于SOLIDWORKS安装文件夹\api\redist,用于面向Framework 4.0及更高版本的项目,位于SOLIDWORKS安装文件夹\api\redist\CLR2,用于面向Framework 2.0和3.5的项目。

如果项目面向Framework 4.0,我建议将所有SOLIDWORKS互操作dll的嵌入互操作类型选项设置为false。在某些情况下,嵌入的互操作库会导致类型转换问题,影响功能并可能导致崩溃。

嵌入SOLIDWORKS互操作{ width=350 }

  • 添加一个具有用户友好名称的公共类,该类将表示插件。此类必须是公共的和COM可见的。我建议使用ComVisibleAttributeGuidAttribute修饰类,以将类型公开给COM并分配永久的全局唯一标识符(GUID):
<ComVisible(True)>
<Guid("799707B3-1632-469F-B294-EC05A5FBFFC8")>
Public Class MySampleAddin
Implements ISwAddin
...
End Class

避免选择使程序集对COM可见选项以将类型公开给COM,只需使用上述描述的属性将所需的类标记为COM可见。

  • 插件dll必须使用/codebase标志进行注册。项目设置中提供的注册COM互操作选项不使用此选项进行注册,因此在此情况下不适用,此外,此选项将在32位注册表中注册类型,而SOLIDWORKS需要在64位注册表中注册条目。相反,添加以下后期构建操作:
"%windir%\Microsoft.NET\Framework64\v4.0.30319\regasm" /codebase "$(TargetPath)"

后期构建事件将dll注册为COM对象

这将确保在每次编译插件项目后进行正确的注册。

  • 为了获得更好的调试体验,我建议在项目设置中指定SOLIDWORKS的完整路径作为外部应用程序。

在调试插件时作为外部程序启动SOLIDWORKS

这将通过按下绿色运行按钮或F5键自动启动SOLIDWORKS并从Visual Studio附加调试器。

  • 需要将注册信息添加到SOLIDWORKS注册表分支中,以使其对应用程序可见。为了简化此过程,可以通过定义函数并使用ComRegisterFunctionAttributeComUnregisterFunctionAttribute属性对它们进行自动添加和删除。

  • 复制粘贴下面显示的插件代码并编译项目

Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swpublished
Imports System
Imports System.ComponentModel
Imports System.Diagnostics
Imports System.Linq
Imports System.Runtime.InteropServices

<ComVisible(True)>
<Guid("799707B3-1632-469F-B294-EC05A5FBFFC8")>
<DisplayName("Sample Add-In")>
<Description("Sample 'Hello World' SOLIDWORKS add-in")>
Public Class MySampleAddin
Implements ISwAddin

Private Const ADDIN_KEY_TEMPLATE As String = "SOFTWARE\SolidWorks\Addins\{{{0}}}"
Private Const ADDIN_STARTUP_KEY_TEMPLATE As String = "Software\SolidWorks\AddInsStartup\{{{0}}}"
Private Const ADD_IN_TITLE_REG_KEY_NAME As String = "Title"
Private Const ADD_IN_DESCRIPTION_REG_KEY_NAME As String = "Description"

#Region "Registration"

<ComRegisterFunction>
Public Shared Sub RegisterFunction(ByVal t As Type)
Try
Dim addInTitle = ""
Dim loadAtStartup = True
Dim addInDesc = ""
Dim dispNameAtt = t.GetCustomAttributes(False).OfType(Of DisplayNameAttribute)().FirstOrDefault()

If dispNameAtt IsNot Nothing Then
addInTitle = dispNameAtt.DisplayName
Else
addInTitle = t.ToString()
End If

Dim descAtt = t.GetCustomAttributes(False).OfType(Of DescriptionAttribute)().FirstOrDefault()

If descAtt IsNot Nothing Then
addInDesc = descAtt.Description
Else
addInDesc = t.ToString()
End If

Dim addInkey = Microsoft.Win32.Registry.LocalMachine.CreateSubKey(String.Format(ADDIN_KEY_TEMPLATE, t.GUID))
addInkey.SetValue(Nothing, 0)
addInkey.SetValue(ADD_IN_TITLE_REG_KEY_NAME, addInDesc)
addInkey.SetValue(ADD_IN_DESCRIPTION_REG_KEY_NAME, addInTitle)
Dim addInStartupkey = Microsoft.Win32.Registry.CurrentUser.CreateSubKey(String.Format(ADDIN_STARTUP_KEY_TEMPLATE, t.GUID))
addInStartupkey.SetValue(Nothing, Convert.ToInt32(loadAtStartup), Microsoft.Win32.RegistryValueKind.DWord)
Catch ex As Exception
Console.WriteLine("Error while registering the addin: " & ex.Message)
End Try

End Sub

<ComUnregisterFunction>
Public Shared Sub UnregisterFunction(ByVal t As Type)
Try
Microsoft.Win32.Registry.LocalMachine.DeleteSubKey(String.Format(ADDIN_KEY_TEMPLATE, t.GUID))
Microsoft.Win32.Registry.CurrentUser.DeleteSubKey(String.Format(ADDIN_STARTUP_KEY_TEMPLATE, t.GUID))
Catch e As Exception
Console.WriteLine("Error while unregistering the addin: " & e.Message)
End Try
End Sub
#End Region

Private m_App As ISldWorks

Public Function ConnectToSW(ByVal ThisSW As Object, ByVal Cookie As Integer) As Boolean Implements ISwAddin.ConnectToSW
m_App = TryCast(ThisSW, ISldWorks)
m_App.SendMsgToUser("Hello World!")
Return True
End Function

Public Function DisconnectFromSW() As Boolean Implements ISwAddin.DisconnectFromSW
Return True
End Function

End Class

  • 可以忽略在Visual Studio窗口中显示的以下警告。

未签名程序集编译警告{ width=450 }

  • 运行SOLIDWORKS,启动时显示Hello World消息框。

上述代码可以使用xCAD.NET Framework框架简化如下:

<Title("Sample Add-In")>
<Description("Sample 'Hello World' SOLIDWORKS add-in")>
<ComVisible(True), Guid("799707B3-1632-469F-B294-EC05A5FBFFC8")>
Public Class MySampleAddIn
Inherits SwAddInEx

Public Overrides Sub OnConnect()
End Sub

End Class