SolidWorksMakroprogrammierung

VBA-Grundlagen

Ereignisse empfangen

Wie ein Makro mitbekommt, was in SOLIDWORKS passiert: Klassenmodul mit WithEvents, Ereignisprozeduren und wie lange das Makro zuhört.

Was Ereignisse sind

SOLIDWORKS meldet, was im Programm passiert: Eine Komponente wird eingefügt, die Datei gespeichert, die Auswahl geändert. Ein Makro kann auf solche Ereignisse reagieren. Diese Objekte haben Ereignisse: SldWorks, AssemblyDoc, PartDoc, DrawingDoc, ModelView, FeatMgrView, Mouse, SWPropertySheet, TaskpaneView und MotionStudy aus der Bibliothek für Bewegungsstudien.

Ein Ereignis rufst du nicht auf. SOLIDWORKS ruft deine Ereignisprozedur auf, sobald das Ereignis eintritt.

Klassenmodul mit WithEvents

In VBA empfängst du Ereignisse über eine Objektvariable, die du mit WithEvents deklarierst. Das geht nur in einem Klassenmodul oder einem Formular, nicht in einem normalen Modul. So legst du es an:

  1. Im VBA-Editor Einfügen › Klassenmodul wählen.
  2. Im Eigenschaftenfenster (F4) den Namen ändern, etwa in clsBaugruppe.
  3. Oben im Klassenmodul die Variable deklarieren: Public WithEvents swAssy As SldWorks.AssemblyDoc.
  4. In der linken Liste über dem Code swAssy wählen, in der rechten das Ereignis. Der Editor legt die Ereignisprozedur an.

Die Ereignisprozedur heißt wie die Variable, ein Unterstrich und das Ereignis, also swAssy_AddItemNotify. Bei SOLIDWORKS ist sie eine Function mit dem Rückgabewert Long. Die Namen der Parameter darfst du ändern, Typ und Reihenfolge nicht.

Der Rückgabewert

Weist du in der Function nichts zu, gibt sie 0 zurück. Das passt fast immer. Bei einigen Ereignissen, die vor einer Aktion kommen, verhindert ein anderer Wert die Aktion, etwa bei AssemblyDoc.FileSaveAsNotify2 das Speichern. Die Hilfe schreibt dafür S_FALSE, das ist in VBA der Wert 1. Was ein Rückgabewert bewirkt, steht beim jeweiligen Ereignis.

Wie lange das Makro zuhört

Das Objekt mit der WithEvents-Variablen muss in einer Variablen auf Modulebene liegen, also außerhalb von main. Eine Variable innerhalb von main verschwindet, sobald main endet, und mit ihr die Ereignisse.

In den Beispielen der Hilfe endet main, nachdem es die Variable gesetzt hat. Die Ereignisse kommen danach weiter an. Das Beispiel „Disable Selection of Faces and Edges Using a Pre-Notify Event“ zeigt: Sie kommen so lange, bis du im VBA-Editor auf Zurücksetzen klickst. Ob das auch gilt, wenn du das Makro über Extras › Makro › Ausführen startest statt im VBA-Editor, sagt die Hilfe nicht.

Jedes Dokument einzeln

Du meldest dich für jedes Objekt einzeln an. Für jede offene Baugruppe brauchst du eine eigene Variable mit WithEvents, ebenso für jede Baugruppe, die später geöffnet wird. Dass ein Dokument geöffnet oder neu angelegt wurde, meldet SldWorks mit seinen eigenen Ereignissen, etwa SldWorks.FileOpenNotify2.

Wird das Dokument geschlossen, kommt AssemblyDoc.DestroyNotify2 (bei Teilen und Zeichnungen gleichnamig). Danach gibst du die Variable mit Set swAssy = Nothing frei.

Vorher und nachher

Viele Ereignisse gibt es paarweise. Eines mit PreNotify im Namen kommt vor der Aktion, eines mit PostNotify danach, etwa AssemblyDoc.UndoPreNotify und AssemblyDoc.UndoPostNotify. Bei Namen, die nur auf Notify enden, steht beim Ereignis, wann es kommt. Wie bei Methoden gibt es neuere Fassungen mit einer Zahl am Ende, etwa DestroyNotify2. Die alten Fassungen sind veraltet. Bei FileSaveAsNotify2 sollst du nicht gleichzeitig auf die alte und die neue Fassung hören.

Beispiel

' Meldet im Direktfenster, wenn in der aktiven Baugruppe etwas eingefügt oder gelöscht wird.
' Vorbedingung: Eine Baugruppe ist offen. Im Makro gibt es das Klassenmodul clsBaugruppe (Code darunter).
' Ergebnis:     Bis du im VBA-Editor auf Zurücksetzen klickst, stehen eingefügte und gelöschte Elemente
'               im Direktfenster.
Option Explicit

Dim mBaugruppe As clsBaugruppe          ' auf Modulebene, damit das Objekt nach main weiterlebt

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    If swModel.GetType <> swDocASSEMBLY Then Exit Sub

    Set mBaugruppe = New clsBaugruppe
    Set mBaugruppe.swAssy = swModel     ' ab jetzt kommen die Ereignisse
End Sub
Option Explicit

Public WithEvents swAssy As SldWorks.AssemblyDoc

Private Function swAssy_AddItemNotify(ByVal EntityType As Long, ByVal itemName As String) As Long
    Debug.Print "Eingefügt: " & itemName
End Function

Private Function swAssy_DeleteItemNotify(ByVal EntityType As Long, ByVal itemName As String) As Long
    Debug.Print "Gelöscht: " & itemName
End Function

Private Function swAssy_DestroyNotify2(ByVal DestroyType As Long) As Long
    If DestroyType = swDestroyNotifyDestroy Then Set swAssy = Nothing      ' Baugruppe wird geschlossen
End Function

Add-ins

In Add-ins mit C# oder VB.NET heißen die Ereignisse nach ihren .NET-Delegates, etwa DAssemblyDocEvents_AddItemNotifyEventHandler. C++-Add-ins melden sich mit den Werten aus swAssemblyNotify_e, swPartNotify_e, swDrawingNotify_e, swAppNotify_e und swViewNotify_e an. In VBA brauchst du diese Werte nicht.

Siehe auch

Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.