Objekt · SldWorks
UserNotificationDefinition-Objekt
Die Definition einer Benachrichtigung, die ein Add-in in SOLIDWORKS anzeigt: Titel, Meldung, Schweregrad, Lage und bis zu zwei Antwortknöpfe.
Beschreibung
UserNotificationDefinition gibt Zugriff auf eine Benachrichtigung (user notification) eines Add-ins. Eine Benachrichtigung ist ein Dialog des Add-ins, der
- dem Benutzer eine eigene Meldung zeigt,
- nicht modal ist,
- im Fenster eines Dokuments oder in SOLIDWORKS selbst erscheinen kann,
- eine zuvor gezeigte Benachrichtigung ersetzt und
- ein Objekt braucht, das UserNotificationHandler (swpublished) umsetzt und die Antworten des Benutzers empfängt.
Die Befehle gibt es seit SOLIDWORKS 2022.
Zugriff
SldWorks.DefineUserNotification: legt die Definition mit einer eindeutigen Kennung an
Angezeigt wird die Benachrichtigung mit SldWorks.ShowUserNotification für SOLIDWORKS oder mit ModelDocExtension.ShowUserNotification für ein Dokument.
Beispiel
' Ausschnitt aus einem Add-in: legt eine Benachrichtigung an und zeigt sie im aktiven
' Dokument oder, ohne Dokument, in SOLIDWORKS.
' Vorbedingung: swApp ist SOLIDWORKS (SldWorks). swHandler ist ein Objekt des Add-ins,
' das UserNotificationHandler (swpublished) umsetzt.
' Ergebnis: Die Benachrichtigung erscheint, das Ergebnis steht im Direktfenster.
Dim swDef As SldWorks.UserNotificationDefinition
Dim swModel As SldWorks.ModelDoc2
Dim nErgebnis As Long
Set swDef = swApp.DefineUserNotification("MeinAddIn+ID_HINWEIS1")
swDef.Severity = swUserNotificationSeverity_Warning
swDef.Title = "Hinweis von MeinAddIn"
swDef.Message = "Etwas Wichtiges ist passiert, das du wissen solltest."
swDef.ResponseAType = swUserNotificationResponseType_Button
swDef.ResponseAText = "OK"
' ResponseBType und ResponseBText bleiben auf None und "", IncludeDoNotShowAgain auf True
Set swModel = swApp.ActiveDoc
If swModel Is Nothing Then
nErgebnis = swApp.ShowUserNotification(swDef, swHandler)
Else
nErgebnis = swModel.Extension.ShowUserNotification(swDef, swHandler)
End If
Select Case nErgebnis
Case swShowNotificationResult_Shown: Debug.Print "Angezeigt"
Case swShowNotificationResult_DontShowAgain: Debug.Print "Benutzer will sie nicht mehr sehen"
Case swShowNotificationResult_FailedInvalidDefinition: Debug.Print "Definition ungültig"
Case swShowNotificationResult_FailedInvalidHandler: Debug.Print "Handler ungültig"
End SelectBemerkungen
Hilfebeispiel: Die Hilfe verweist auf die Beispiele zu IUserNotificationHandler. Dort steht ein C#-Add-in: eine Klasse, die IUserNotificationHandler umsetzt (OnUserClose, OnUserResponseA, OnUserResponseB, OnTimeout), und eine Funktion ShowNotification, die die Definition wie oben anlegt und anzeigt. Das Beispiel oben überträgt diesen Ablauf nach VBA.
Pflichtangaben: UserNotificationDefinition.Title und UserNotificationDefinition.Message musst du setzen. Fehlt eine davon, liefert ShowUserNotification swShowNotificationResult_FailedInvalidDefinition (ohne Titel und ohne Meldung kam jeweils 2 zurück).
VBA: Auch ein VBA-Makro kann den Handler umsetzen, mit Implements UserNotificationHandler in einem Klassenmodul; die vier Ereignisse sind dort Subs. Schließen kannst du die Benachrichtigung mit SldWorks.CloseUserNotification oder ModelDocExtension.CloseUserNotification.
Eigenschaften und Methoden
Eigenschaften 10, davon 10 beschrieben
| Name | Beschreibung |
|---|---|
| IncludeDoNotShowAgain | Liest oder setzt, ob die Benachrichtigung das Kästchen „Nicht mehr anzeigen“ hat. |
| Message | Liest oder setzt die Meldung der Benachrichtigung. |
| Position | Liest oder setzt, wo im Fenster die Benachrichtigung erscheint. |
| ResponseAText | Liest oder setzt die Beschriftung der ersten Antwort, also des ersten Knopfs oder Befehlslinks. |
| ResponseAType | Liest oder setzt, ob die erste Antwort ein Knopf, ein Befehlslink oder nichts ist. |
| ResponseBText | Liest oder setzt die Beschriftung der zweiten Antwort, also des zweiten Knopfs oder Befehlslinks. |
| ResponseBType | Liest oder setzt, ob die zweite Antwort ein Knopf, ein Befehlslink oder nichts ist. |
| Severity | Liest oder setzt den Schweregrad der Benachrichtigung: Information, Bestätigung, Warnung oder Fehler. |
| Title | Liest oder setzt den Titel der Benachrichtigung. |
| UniqueName | Liefert die Kennung der Benachrichtigung. |
Siehe auch
Englisches Original: IUserNotificationDefinition in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.