Objekt · SldWorks
CommandTabBox-Objekt
Ein Feld auf einer Registerkarte des CommandManagers, das die Schaltflächen eines Add-ins aufnimmt.
Beschreibung
Mit CommandTabBox legen Add-ins Felder auf einer Registerkarte (CommandTab) an. Das Add-in muss seine Felder selbst anlegen und wieder aufräumen. Jede Schaltfläche im Feld steht für einen Befehl einer Befehlsgruppe, für eine ganze Symbolleiste oder für ein Flyout und wird über ihre Befehls-ID angesprochen. Für jede Schaltfläche legst du fest, ob und wo ihr Text erscheint.
Zugriff
CommandTab.AddCommandTabBox: ein neues, leeres FeldCommandTab.CommandTabBoxes: alle Felder einer RegisterkarteCommandTab.AddSeparator: das neue Feld rechts von einem Trenner
Beispiel
' Legt beim Laden des Add-ins eine Befehlsgruppe mit zwei Befehlen an und zeigt sie in einem Feld
' der Registerkarte „Werkzeuge“ für Baugruppen: einen Befehl mit Text unter dem Symbol, einen nur
' als Symbol und die ganze Symbolleiste mit Text neben dem Symbol.
' 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 Baugruppen gibt es die Registerkarte „Werkzeuge“ mit einem Feld. Beim ersten Laden
' steht die Zahl seiner Schaltflächen im Direktfenster.
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, vIds As Variant, vText 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(swDocASSEMBLY, "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(swDocASSEMBLY, "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_TextBelow ' Text unter dem Symbol
aText(1) = swCommandTabButton_NoText ' nur das Symbol
aText(2) = swCommandTabButton_TextHorizontal ' Text neben dem Symbol
If swTabBox.AddCommands(aIds, aText) Then
Debug.Print swTabBox.GetCommands(vIds, vText) & " Schaltflächen im Feld"
End If
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
Public Sub Info()
If swApp.ActiveDoc Is Nothing Then Exit Sub
swApp.SendMsgToUser2 swApp.ActiveDoc.GetTitle, swMbInformation, swMbOk
End SubBemerkungen
Befehls-IDs: Die IDs für CommandTabBox.AddCommands und CommandTabBox.RemoveCommands liefern CommandGroup.CommandID und CommandGroup.ToolbarId, aber erst nach CommandGroup.Activate. Bei Flyouts nimmst du CmdID von FlyoutGroup.
Textanzeige: Die Werte kommen aus swCommandTabButtonTextDisplay_e, je Schaltfläche einer, in derselben Reihenfolge wie die IDs. Die Hilfe nennt sie eine Bitmaske. Im C#-Beispiel „Create Flyouts in the CommandManager“ verknüpft sie die Textanzeige der Symbolleiste und des Flyouts mit Or mit einem Wert aus swCommandTabButtonFlyoutStyle_e.
Sichtbarkeit: Wie bei CommandTab.AddCommandTabBox beschrieben, ist ein neues Feld erst sichtbar, wenn es Schaltflächen hat.
Beispiel: Das Beispiel folgt den Beispielen „Create CommandManager Tab and Tab Boxes“ der Hilfe in VB.NET und C#, ein VBA-Beispiel gibt es dort nicht. Dort sind die Arrays für das erste Feld um ein Element zu groß, und ob SOLIDWORKS die überzählige 0 übergeht, sagt die Hilfe nicht. Das Beispiel hier legt die Arrays genau passend an.
Aus einem Makro heraus liefert SldWorks.GetCommandManager Nothing; Registerkarten gibt es nur in einem Add-in.
Eigenschaften und Methoden
Methoden 3, davon 3 beschrieben
| Name | Beschreibung |
|---|---|
| AddCommands | Fügt dem Feld der Registerkarte Schaltflächen hinzu, je Befehls-ID eine. |
| GetCommands | Liefert die Befehls-IDs und Textanzeigen der Schaltflächen im Feld und ihre Zahl. |
| RemoveCommands | Entfernt Schaltflächen aus dem Feld der Registerkarte. |
Nicht aufgeführt sind 3 C++-Varianten (Namen mit I davor, zum Beispiel IAddCommands). In VBA nimmst du immer den Befehl ohne I.
Siehe auch
Englisches Original: ICommandTabBox in der SOLIDWORKS API-Hilfe ↗ (dort mit dem .NET-Namen)
Fragen zu diesem Befehl oder ein Befehl fehlt? Frag im Discord.