Objekt · SldWorks
CommandGroup-Objekt
Eine Befehlsgruppe eines Add-ins: Menü und Symbolleiste mit eigenen Befehlen, auch als Kontextmenü.
Beschreibung
Mit CommandGroup legen Add-ins Menüs und Symbolleisten an, auch Flyouts und Untermenüs, und fügen sie dem CommandManager hinzu. Menü und Symbolleiste einer Gruppe gehören zusammen: Sie haben denselben Namen, dieselben Schaltflächen und dieselben Callbacks. Den CommandManager gibt es nur in Add-ins, ein gewöhnliches Makro kommt an ihn nicht heran.
Zugriff
CommandManager.CreateCommandGroup2: eine neue BefehlsgruppeCommandManager.AddContextMenu: ein neues KontextmenüCommandManager.GetCommandGroup: eine Befehlsgruppe über ihre IDCommandManager.GetGroups: alle Befehlsgruppen des Add-ins
Beispiel
' Legt beim Laden des Add-ins das Menü und die Symbolleiste „Werkzeuge“ mit dem Befehl „Hallo“ an
' und entfernt sie beim Entladen.
' Vorbedingung: Ein Add-in als COM-DLL, etwa in VB6, mit Verweisen auf die SOLIDWORKS-Bibliotheken
' sldworks, swconst und swpublished. Die Bilder liegen unter C:\Werkzeuge.
' Ergebnis: Nach dem Laden des Add-ins gibt es den Befehl „Hallo“ in Menü und Symbolleiste.
Option Explicit
Implements SwAddin
Private swApp As SldWorks.SldWorks
Private swCmdMgr As SldWorks.CommandManager
Private nCookie As Long
Private Const GRUPPE_ID As Long = 10 ' eigene, eindeutige ID der Gruppe
Private Function SwAddin_ConnectToSW(ByVal ThisSW As Object, ByVal Cookie As Long) As Boolean
Dim swCmdGrp As SldWorks.CommandGroup
Dim aSymbole(0) As String, aHaupt(0) As String
Dim nFehler As Long
Set swApp = ThisSW
nCookie = Cookie
swApp.SetAddinCallbackInfo2 0, Me, nCookie ' diese Klasse enthält die Callbacks
Set swCmdMgr = swApp.GetCommandManager(nCookie)
Set swCmdGrp = swCmdMgr.CreateCommandGroup2(GRUPPE_ID, "Werkzeuge", "Eigene Werkzeuge", "", -1, True, nFehler)
If swCmdGrp Is Nothing Then Exit Function
aSymbole(0) = "C:\Werkzeuge\Symbole_20.png" ' alle Schaltflächen nebeneinander
aHaupt(0) = "C:\Werkzeuge\Haupt_20.png"
swCmdGrp.IconList = aSymbole
swCmdGrp.MainIconList = aHaupt
swCmdGrp.AddCommandItem2 "Hallo", -1, "Zeigt eine Meldung", "Hallo", 0, "Hallo", "HalloAktiv", 1, _
swMenuItem + swToolbarItem
swCmdGrp.HasToolbar = True
swCmdGrp.HasMenu = True
swCmdGrp.Activate
SwAddin_ConnectToSW = True
End Function
Private Function SwAddin_DisconnectFromSW() As Boolean
swCmdMgr.RemoveCommandGroup2 GRUPPE_ID, False
Set swCmdMgr = Nothing
Set swApp = Nothing
SwAddin_DisconnectFromSW = True
End Function
Public Sub Hallo() ' Callback des Befehls
swApp.SendMsgToUser2 "Hallo aus dem Add-in", swMbInformation, swMbOk
End Sub
Public Function HalloAktiv() As Long ' Enable-Methode: 1 = aktiv
HalloAktiv = 1
End FunctionBemerkungen
Ablauf: So beschreibt es die Übersicht „CommandManager and CommandGroups“: Du holst den CommandManager mit SldWorks.GetCommandManager, legst die oberste Gruppe an, gibst ihr die Bilder, fügst die Befehle hinzu, schaltest Menü und Symbolleiste ein oder aus und rufst zum Schluss CommandGroup.Activate auf. Die Bilder brauchst du nur bei der obersten Gruppe. Beim Entladen entfernst du die Gruppe mit CommandManager.RemoveCommandGroup2.
Gruppe ändern: SOLIDWORKS merkt sich die Symbolleisten in der Registry. Änderst du später die Befehle einer Gruppe, gibst du ihr eine neue ID oder prüfst vorher mit CommandManager.GetGroupDataFromRegistry, ob du IgnorePreviousVersion bei CommandManager.CreateCommandGroup2 setzen musst.
Beispiel: Das Beispiel folgt den C#- und VB.NET-Beispielen der Hilfe, ein VBA-Beispiel gibt es dort nicht. Ob 0 als ModuleHandle bei SldWorks.SetAddinCallbackInfo2 reicht, sagt die Hilfe nicht.
Veraltete Befehle: AddCommandItem, AddSpacer, LargeIconList, SmallIconList, LargeMainIcon und SmallMainIcon sind veraltet. An ihre Stelle treten CommandGroup.AddCommandItem2, CommandGroup.AddSpacer2, CommandGroup.IconList und CommandGroup.MainIconList.
Aus einem Makro heraus liefert SldWorks.GetCommandManager Nothing; Befehlsgruppen gibt es nur in einem Add-in.
Eigenschaften und Methoden
Eigenschaften 18, davon 14 beschrieben, 4 veraltet
| Name | Beschreibung |
|---|---|
| CommandID | Liefert die Befehls-ID eines Eintrags der Befehlsgruppe, etwa für eine Registerkarte des CommandManagers. |
| CustomNames | Liest oder setzt die Namen eigener Feature-Typen, bei denen das Kontextmenü der Befehlsgruppe erscheint, etwa von Attributen. |
| DockingState | Liest oder setzt, wo die Symbolleiste der Befehlsgruppe angedockt ist. |
| HasEnabledButton | Liefert, ob mindestens eine Schaltfläche der Befehlsgruppe aktiv ist. |
| HasMenu | Liest oder setzt, ob die Befehlsgruppe ein Menü hat. |
| HasToolbar | Liest oder setzt, ob die Befehlsgruppe eine Symbolleiste hat. |
| IconList | Liest oder setzt die Bilddateien mit den Symbolen aller Schaltflächen der Befehlsgruppe, je Größe eine Datei. |
| LargeIconList | veraltet ersetzt durch CommandGroup.IconList |
| LargeMainIcon | veraltet ersetzt durch CommandGroup.MainIconList |
| MainIconList | Liest oder setzt die Bilddateien mit dem Symbol der Befehlsgruppe selbst, je Größe eine Datei. |
| MenuPosition | Liest oder setzt die Stelle der Befehlsgruppe im Menü für bestimmte Dokumentarten. |
| Name | Liefert den Namen der Befehlsgruppe. |
| NumberOfGroupItems | Liefert die Zahl der Einträge in der Befehlsgruppe. |
| SelectType | Liest oder setzt, bei welcher Art von Auswahl das Kontextmenü der Befehlsgruppe erscheint. |
| ShowInDocumentType | Liest oder setzt, in welchen Dokumentarten das Menü der Befehlsgruppe erscheint. |
| SmallIconList | veraltet ersetzt durch CommandGroup.IconList |
| SmallMainIcon | veraltet ersetzt durch CommandGroup.MainIconList |
| ToolbarId | Liefert die ID der Symbolleiste der Befehlsgruppe. |
Methoden 7, davon 5 beschrieben, 2 veraltet
| Name | Beschreibung |
|---|---|
| Activate | Aktiviert die fertig eingerichtete Befehlsgruppe, sodass Menü und Symbolleiste erscheinen. |
| AddCommandItem | veraltet ersetzt durch CommandGroup.AddCommandItem2 |
| AddCommandItem2 | Fügt der Befehlsgruppe einen Befehl hinzu, als Menüeintrag, Schaltfläche oder beides. |
| AddSpacer | veraltet ersetzt durch CommandGroup.AddSpacer2 |
| AddSpacer2 | Fügt zwischen den Einträgen der Befehlsgruppe einen Trenner ein. |
| GetToolbarVisibility | Liefert, ob die Symbolleiste der Befehlsgruppe in einer Dokumentart sichtbar ist. |
| SetToolbarVisibility | Blendet die Symbolleiste der Befehlsgruppe für bestimmte Dokumentarten ein oder aus. |
Siehe auch
Englisches Original: ICommandGroup in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.