Objekt · SldWorks
CommandTab-Objekt
Eine Registerkarte des CommandManagers, die ein Add-in anlegt, mit Feldern für ihre Schaltflächen.
Beschreibung
Mit CommandTab legen Add-ins eigene Registerkarten im CommandManager von SOLIDWORKS an. Das Add-in muss seine Registerkarten selbst anlegen und wieder aufräumen. Die Schaltflächen stehen in Feldern (CommandTabBox), die durch Trenner voneinander abgesetzt sind. Ein gewöhnliches Makro kommt an die Registerkarten eines Add-ins nicht heran. Es kann aber mit ModelDocExtension.ActiveCommandTab und ModelDocExtension.CommandTabVisible Registerkarten umschalten und ein- oder ausblenden.
Zugriff
CommandManager.AddCommandTab: eine neue RegisterkarteCommandManager.GetCommandTab: eine vorhandene Registerkarte über ihren NamenCommandManager.CommandTabs: alle Registerkarten des Add-ins für eine Dokumentart
Beispiel
' Legt beim Laden des Add-ins eine Befehlsgruppe mit zwei Befehlen an und zeigt sie auf der
' Registerkarte „Werkzeuge“ für Teile: links die beiden Befehle, nach einem Trenner die ganze
' Symbolleiste. Beim Entladen wird die Gruppe entfernt, die Registerkarte bleibt stehen.
' 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 zwei Feldern.
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(2) As Long, aText(2) As Long
Dim vGespeichert As Variant
Dim bNeu As Boolean
Dim nHallo As Long, nInfo 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) <> 1) ' 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
nHallo = swCmdGrp.AddCommandItem2("Hallo", -1, "Zeigt eine Meldung", "Hallo", 0, "Hallo", "", 1, _
swMenuItem + swToolbarItem)
nInfo = swCmdGrp.AddCommandItem2("Info", -1, "Zeigt den Namen des Dokuments", "Info", 1, "Info", "", 2, _
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(nHallo) ' IDs erst nach Activate
aIds(1) = swCmdGrp.CommandID(nInfo)
aIds(2) = swCmdGrp.ToolbarId ' die ganze Symbolleiste
aText(0) = swCommandTabButton_TextHorizontal
aText(1) = swCommandTabButton_TextHorizontal
aText(2) = swCommandTabButton_TextBelow
swTabBox.AddCommands aIds, aText
swTab.AddSeparator swTabBox, aIds(2) ' Trenner vor der Symbolleiste
End If
Debug.Print swTab.Name & ": " & swTab.GetCommandTabBoxCount & " Felder"
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
Public Sub Info()
If swApp.ActiveDoc Is Nothing Then Exit Sub
swApp.SendMsgToUser2 swApp.ActiveDoc.GetTitle, swMbInformation, swMbOk
End SubBemerkungen
Vorhandene Registerkarte nutzen: Dein Add-in prüft, ob es die Registerkarte schon gibt, und nimmt dann diese. Sonst legt SOLIDWORKS bei jedem Start eine neue an, denn Namen von Registerkarten sind nicht eindeutig.
Anpassungen des Benutzers: Benutzer können Schaltflächen auf deiner Registerkarte hinzufügen und entfernen. Entfernt dein Add-in die Registerkarte beim Beenden, gehen diese Anpassungen verloren. Das Beispiel lässt sie deshalb stehen und erneuert sie nur, wenn die Befehlsgruppe nicht mehr zu den gespeicherten Daten passt.
Trenner: Ein Trenner ist kein eigenes Objekt. CommandTab.AddSeparator teilt ein Feld vor einer Schaltfläche in zwei Felder. Im Beispiel entstehen so aus einem Feld mit drei Schaltflächen zwei Felder.
Beispiel: Das Beispiel folgt dem VB.NET-Beispiel „Create CommandManager Tab and Tab Boxes“ der Hilfe, ein VBA-Beispiel gibt es dort nicht. Dass CommandManager.GetGroupDataFromRegistry bei zwei gespeicherten Befehlen ein Array mit der Obergrenze 1 liefert, ist eine Annahme.
Aus einem Makro heraus liefert SldWorks.GetCommandManager Nothing; Registerkarten gibt es nur in einem Add-in.
Eigenschaften und Methoden
Eigenschaften 3, davon 3 beschrieben
| Name | Beschreibung |
|---|---|
| Active | Liest oder setzt, ob die Registerkarte des CommandManagers aktiv ist. |
| Name | Liest oder setzt den Namen der Registerkarte des CommandManagers. |
| Visible | Liest oder setzt, ob die Registerkarte des CommandManagers angezeigt wird. |
Methoden 5, davon 5 beschrieben
| Name | Beschreibung |
|---|---|
| AddCommandTabBox | Fügt der Registerkarte ein neues Feld für Schaltflächen hinzu. |
| AddSeparator | Teilt ein Feld der Registerkarte vor einer Schaltfläche in zwei Felder, mit einem Trenner dazwischen. |
| CommandTabBoxes | Liefert die Felder der Registerkarte. |
| GetCommandTabBoxCount | Liefert die Zahl der Felder auf der Registerkarte. |
| RemoveCommandTabBox | Entfernt ein Feld mit seinen Schaltflächen von der Registerkarte. |
Nicht aufgeführt sind 1 C++-Varianten (Namen mit I davor, zum Beispiel IGetCommandTabBoxes). In VBA nimmst du immer den Befehl ohne I.
Siehe auch
Englisches Original: ICommandTab in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.