SolidWorksMakroprogrammierung

Objekt · SldWorks

CommandManager-Objekt

Der CommandManager eines Add-ins: Befehlsgruppen, Kontextmenüs, Flyouts und eigene Registerkarten anlegen und entfernen.

Deklaration Dim x As SldWorks.CommandManager · in der englischen .NET-Hilfe: ICommandManager

Beschreibung

Mit CommandManager fügen Add-ins dem CommandManager von SOLIDWORKS Befehlsgruppen hinzu, also Menüs und Symbolleisten, und entfernen sie wieder. Dazu kommen Kontextmenüs, Flyouts und eigene Registerkarten. Ein Add-in hat genau einen CommandManager. Ein gewöhnliches Makro kommt an ihn nicht heran, denn SldWorks.GetCommandManager braucht das Cookie aus ConnectToSW.

Zugriff

Beispiel

' Legt beim Laden des Add-ins eine Befehlsgruppe mit einem Befehl an und zeigt den Befehl
' auf der Registerkarte „Werkzeuge“ für Teile. Beim Entladen wird die Gruppe entfernt.
' 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:     In Teilen gibt es die Registerkarte „Werkzeuge“ mit dem Befehl „Hallo“.
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

Private Function SwAddin_ConnectToSW(ByVal ThisSW As Object, ByVal Cookie As Long) As Boolean
    Dim swCmdGrp As SldWorks.CommandGroup
    Dim swTab As SldWorks.CommandTab
    Dim swTabBox As SldWorks.CommandTabBox
    Dim aSymbole(0) As String, aHaupt(0) As String
    Dim aIds(0) As Long, aText(0) As Long
    Dim vGespeichert As Variant
    Dim bNeu As Boolean
    Dim nIndex As Long, nFehler As Long

    Set swApp = ThisSW
    nCookie = Cookie
    swApp.SetAddinCallbackInfo2 0, Me, nCookie
    Set swCmdMgr = swApp.GetCommandManager(nCookie)

    If swCmdMgr.GetGroupDataFromRegistry(GRUPPE_ID, vGespeichert) Then
        bNeu = (UBound(vGespeichert) <> 0)                     ' gespeichert ist eine andere Gruppe
    End If
    Set swCmdGrp = swCmdMgr.CreateCommandGroup2(GRUPPE_ID, "Werkzeuge", "Eigene Werkzeuge", "", -1, bNeu, nFehler)
    If swCmdGrp Is Nothing Then Exit Function
    aSymbole(0) = "C:\Werkzeuge\Symbole_20.png"
    aHaupt(0) = "C:\Werkzeuge\Haupt_20.png"
    swCmdGrp.IconList = aSymbole
    swCmdGrp.MainIconList = aHaupt
    nIndex = swCmdGrp.AddCommandItem2("Hallo", -1, "Zeigt eine Meldung", "Hallo", 0, "Hallo", "", 1, _
                                      swMenuItem + swToolbarItem)
    swCmdGrp.Activate

    Set swTab = swCmdMgr.GetCommandTab(swDocPART, "Werkzeuge")
    If Not swTab Is Nothing And bNeu Then                       ' alte Registerkarte passt nicht mehr
        swCmdMgr.RemoveCommandTab swTab
        Set swTab = Nothing
    End If
    If swTab Is Nothing Then
        Set swTab = swCmdMgr.AddCommandTab(swDocPART, "Werkzeuge")
        Set swTabBox = swTab.AddCommandTabBox
        aIds(0) = swCmdGrp.CommandID(nIndex)                   ' erst nach Activate
        aText(0) = swCommandTabButton_TextBelow
        swTabBox.AddCommands aIds, aText
    End If
    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()
    swApp.SendMsgToUser2 "Hallo aus dem Add-in", swMbInformation, swMbOk
End Sub

Bemerkungen

Registry: SOLIDWORKS merkt sich die Symbolleisten der Befehlsgruppen in der Registry. Vor CommandManager.CreateCommandGroup2 prüfst du mit CommandManager.GetGroupDataFromRegistry, ob die gespeicherten Befehle noch zu deiner Gruppe passen, und setzt sonst IgnorePreviousVersion. Änderst du die Befehle einer Gruppe, gibst du ihr eine neue ID. Das Beispiel prüft der Kürze halber nur die Zahl der gespeicherten Befehle.

Registerkarten: Wie bei CommandTab beschrieben, prüft dein Add-in, ob es seine Registerkarte schon gibt. Sonst legt SOLIDWORKS bei jedem Start eine neue an. Entfernt das Add-in die Registerkarte beim Beenden, gehen Anpassungen des Benutzers verloren. Das Beispiel lässt sie deshalb stehen und erneuert sie nur, wenn die Gruppe neu angelegt wurde.

Beispiel: Das Beispiel folgt den C#- und VB.NET-Beispielen der Hilfe, ein VBA-Beispiel gibt es dort nicht.

Veraltete Befehle: CreateCommandGroup, CreateFlyoutGroup und RemoveCommandGroup sind veraltet. An ihre Stelle treten CommandManager.CreateCommandGroup2, CommandManager.CreateFlyoutGroup2 und CommandManager.RemoveCommandGroup2.

Aus einem Makro heraus liefert SldWorks.GetCommandManager Nothing; Befehlsgruppen gibt es nur in einem Add-in.

Eigenschaften und Methoden

Eigenschaften 2, davon 2 beschrieben

NameBeschreibung
NumberOfFlyoutGroupsLiefert die Zahl der Flyouts im CommandManager des Add-ins.
NumberOfGroupsLiefert die Zahl der Befehlsgruppen im CommandManager des Add-ins.

Methoden 19, davon 16 beschrieben, 3 veraltet

NameBeschreibung
AddCommandTabLegt im CommandManager eine neue Registerkarte für eine Dokumentart an.
AddContextMenuLegt ein neues Kontextmenü an, als Befehlsgruppe.
CommandTabsLiefert alle Registerkarten des Add-ins für eine Dokumentart.
CreateCommandGroupveraltet ersetzt durch CommandManager.CreateCommandGroup2
CreateCommandGroup2Legt eine neue Befehlsgruppe an, also ein Menü und eine Symbolleiste des Add-ins.
CreateFlyoutGroupveraltet ersetzt durch CommandManager.CreateFlyoutGroup2
CreateFlyoutGroup2Legt ein neues Flyout für den CommandManager und Kontextmenüs an.
GetCommandGroupLiefert eine Befehlsgruppe des Add-ins über ihre ID.
GetCommandIDsCountLiefert die Zahl der Befehls-IDs, die für eine Befehlsgruppe in der Registry stehen.
GetCommandTabLiefert eine Registerkarte des Add-ins über Dokumentart und Namen.
GetCommandTabCountLiefert die Zahl der Registerkarten im CommandManager für eine Dokumentart.
GetFlyoutGroupLiefert ein Flyout über seine ID.
GetFlyoutGroupsLiefert alle Flyouts im CommandManager des Add-ins.
GetGroupDataFromRegistryLiefert die Befehls-IDs einer Befehlsgruppe, wie sie in der Registry gespeichert sind.
GetGroupsLiefert alle Befehlsgruppen im CommandManager des Add-ins.
RemoveCommandGroupveraltet ersetzt durch CommandManager.RemoveCommandGroup2
RemoveCommandGroup2Entfernt eine Befehlsgruppe oder ein Kontextmenü aus dem CommandManager.
RemoveCommandTabEntfernt eine Registerkarte mit ihren Feldern und Schaltflächen aus dem CommandManager.
RemoveFlyoutGroupEntfernt ein Flyout aus dem CommandManager.

Nicht aufgeführt sind 3 C++-Varianten (Namen mit I davor, zum Beispiel IGetCommandTabs). In VBA nimmst du immer den Befehl ohne I.

Siehe auch

Englisches Original: ICommandManager in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)

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