Objekt · SldWorks
MessageBarDefinition-Objekt
Die Definition einer Meldungsleiste, die ein Add-in im Fenster eines Dokuments zeigt: Titel, Meldung, Schweregrad und bis zu zwei Antworten.
Beschreibung
MessageBarDefinition gibt Zugriff auf eine Meldungsleiste (message bar) eines Add-ins. Eine Meldungsleiste ist ein Dialog, der
- einem Add-in erlaubt, dem Benutzer eine Meldung zu zeigen,
- nicht modal ist und eine eigene Meldung enthält,
- nur bei einem Dokument erscheint, das in einem eigenen Fenster offen ist,
- mit anderen Meldungsleisten gestapelt sein kann und
- ein Objekt braucht, das MessageBarHandler (swpublished) umsetzt und die Ereignisse der Leiste empfängt.
Die Befehle gibt es seit SOLIDWORKS 2022.
Zugriff
SldWorks.DefineMessageBar: legt die Definition mit einer eindeutigen Kennung an
Angezeigt wird die Meldungsleiste mit ModelDocExtension.ShowMessageBar im Fenster eines Dokuments, geschlossen mit ModelDocExtension.CloseMessageBar.
Beispiel
' Ausschnitt aus einem Add-in: legt die Meldungsleiste beim ersten Aufruf an, setzt
' die Meldung für das aktive Dokument und zeigt die Leiste in dessen Fenster.
' Vorbedingung: swApp ist SOLIDWORKS (SldWorks). swHandler ist ein Objekt des Add-ins,
' das MessageBarHandler (swpublished) umsetzt. Ein Dokument ist offen.
' Ergebnis: Die Meldungsleiste erscheint, das Ergebnis steht im Direktfenster.
Private swDef As SldWorks.MessageBarDefinition
Sub MeldungZeigen()
Dim swModel As SldWorks.ModelDoc2
Dim nErgebnis As Long
Set swModel = swApp.ActiveDoc
If swModel Is Nothing Then Exit Sub ' Meldungsleisten gehören zu einem Dokument
If swDef Is Nothing Then
Set swDef = swApp.DefineMessageBar("MeinAddIn+MELDUNG_B")
swDef.Severity = swUserMessageBarSeverity_Warning
swDef.Title = "Meldungsleiste von MeinAddIn"
swDef.ResponseAType = swUserMessageBarResponseType_Button
swDef.ResponseAText = "OK"
' ResponseBType und ResponseBText bleiben auf None und "", IncludeDoNotShowAgain auf True
End If
swDef.Message = "Mit " & swModel.GetTitle & " ist etwas Wichtiges passiert."
nErgebnis = swModel.Extension.ShowMessageBar(swDef, swHandler)
Select Case nErgebnis
Case swShowMessageBarResult_Shown: Debug.Print "Angezeigt"
Case swShowMessageBarResult_DontShowAgain: Debug.Print "Benutzer will sie nicht mehr sehen"
Case swShowMessageBarResult_FailedInvalidDefinition: Debug.Print "Definition ungültig"
Case swShowMessageBarResult_FailedInvalidHandler: Debug.Print "Handler ungültig"
End Select
End SubBemerkungen
Hilfebeispiel: Die Hilfe verweist auf die Beispiele zu IMessageBarHandler. Dort steht ein C#-Add-in: eine Klasse, die IMessageBarHandler umsetzt (OnUserClose, OnUserResponseA, OnUserResponseB), und eine Funktion ShowUserMessage. Sie legt die Definition nur beim ersten Aufruf an, setzt vor jedem Anzeigen nur die Meldung neu und zeigt die Leiste mit ModelDocExtension.ShowMessageBar. Das Beispiel oben überträgt diesen Ablauf nach VBA.
Namen im Hilfebeispiel: Das Hilfebeispiel schreibt die Enums als swMessageBarSeverity_e und swMessageBarResponseType_e. Diese gibt es in swconst nicht, gemeint sind swUserMessageBarSeverity_e und swUserMessageBarResponseType_e.
Pflichtangaben: MessageBarDefinition.Title und MessageBarDefinition.Message musst du setzen. Fehlen sie, liefert ShowMessageBar swShowMessageBarResult_FailedInvalidDefinition (swShowMessageBarResult_e). Wählst du für eine Antwort eine Schaltfläche oder einen Befehlslink, braucht sie eine Beschriftung, die nicht leer ist.
Handler: Klickt der Benutzer auf die erste oder zweite Antwort, ruft SOLIDWORKS im Handler OnUserResponseA bzw. OnUserResponseB auf, mit dem Stand von „Nicht mehr anzeigen“ als Parameter DoNotShowAgain. Schließt er die Leiste, ruft SOLIDWORKS OnUserClose auf. Im Hilfebeispiel behält SOLIDWORKS den Handler, bis die Leiste geschlossen und das passende Ereignis aufgerufen ist. Ein VBA-Makro kann den Handler mit Implements MessageBarHandler in einem Klassenmodul umsetzen (mit Verweis auf swpublished.tlb); OnUserClose hat dabei keinen Parameter. Schließen kannst du die Leiste auch selbst mit ModelDocExtension.CloseMessageBar.
Benachrichtigungen: Ähnlich arbeitet UserNotificationDefinition. Eine solche Benachrichtigung kann auch ohne Dokument in SOLIDWORKS erscheinen und hat eine Lage im Fenster (UserNotificationDefinition.Position). Eine Meldungsleiste gehört immer zu einem Dokument.
Eigenschaften und Methoden
Eigenschaften 9, davon 9 beschrieben
| Name | Beschreibung |
|---|---|
| IncludeDoNotShowAgain | Liest oder setzt, ob die Meldungsleiste das Kontrollkästchen „Nicht mehr anzeigen“ hat. |
| Message | Liest oder setzt die Meldung der Meldungsleiste. |
| ResponseAText | Liest oder setzt die Beschriftung der ersten Antwort, also der ersten Schaltfläche oder des ersten Befehlslinks. |
| ResponseAType | Liest oder setzt, ob die erste Antwort eine Schaltfläche, ein Befehlslink oder nichts ist. |
| ResponseBText | Liest oder setzt die Beschriftung der zweiten Antwort, also der zweiten Schaltfläche oder des zweiten Befehlslinks. |
| ResponseBType | Liest oder setzt, ob die zweite Antwort eine Schaltfläche, ein Befehlslink oder nichts ist. |
| Severity | Liest oder setzt den Schweregrad der Meldungsleiste: Information, Bestätigung, Warnung oder Fehler. |
| Title | Liest oder setzt den Titel der Meldungsleiste. |
| UniqueName | Liefert die Kennung der Meldungsleiste. |
Siehe auch
Englisches Original: IMessageBarDefinition in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.