SolidWorksMakroprogrammierung

Methode · CommandGroup

AddCommandItem2-Methode (CommandGroup)

Fügt der Befehlsgruppe einen Befehl hinzu, als Menüeintrag, Schaltfläche oder beides.

Syntax

Function AddCommandItem2( _
   ByVal Name As String, _
   ByVal Position As Long, _
   ByVal HintString As String, _
   ByVal ToolTip As String, _
   ByVal ImageListIndex As Long, _
   ByVal CallbackFunction As String, _
   ByVal EnableMethod As String, _
   ByVal UserID As Long, _
   ByVal MenuTBOption As Long _
) As Long
nIndex = swCmdGrp.AddCommandItem2("Hallo", -1, "Zeigt eine Meldung", "Hallo", 0, "Hallo", "HalloAktiv", 1, swMenuItem + swToolbarItem)

Parameter

NameStringByVal
Der Name des Eintrags.
PositionLongByVal
Die Stelle in der Gruppe: 0 am Anfang, -1 am Ende. Sie gilt relativ zum direkt übergeordneten Eintrag.
HintStringStringByVal
Der Text in der Statusleiste, wenn der Mauszeiger auf dem Eintrag steht.
ToolTipStringByVal
Die QuickInfo des Eintrags.
ImageListIndexLongByVal
Die Nummer des Symbols in den Bildern aus CommandGroup.IconList, ab 0. -1 für einen Menüeintrag ohne Symbol.
CallbackFunctionStringByVal
Der Name der Methode, die SOLIDWORKS beim Klick aufruft.
EnableMethodStringByVal
Optional der Name der Methode, die den Zustand des Eintrags liefert (siehe Bemerkungen), sonst eine leere Zeichenkette.
UserIDLongByVal
Eine eigene Befehls-ID oder 0.
MenuTBOptionLongByVal
Menüeintrag, Schaltfläche oder beides, als Werte aus swCommandItemType_e.

Rückgabewert

Der Index des Eintrags in der Gruppe, von SOLIDWORKS vergeben.

Beispiel

' Im Add-in, in ConnectToSW: swCmdGrp ist eine Befehlsgruppe (CommandGroup), die Klasse enthält die Methoden unten.
Dim nIndex As Long
nIndex = swCmdGrp.AddCommandItem2("Hallo", -1, "Zeigt eine Meldung", "Hallo", 0, "Hallo", "HalloAktiv", 1, swMenuItem + swToolbarItem)

' In derselben Klasse:
Public Sub Hallo()
    swApp.SendMsgToUser2 "Hallo aus dem Add-in", swMbInformation, swMbOk
End Sub

Public Function HalloAktiv() As Long
    HalloAktiv = 1                                         ' abgewählt und aktiv
End Function

Bemerkungen

Die Enable-Methode liefert einen dieser Werte:

  • 0: abgewählt und gesperrt
  • 1: abgewählt und aktiv, so ist es auch ohne Enable-Methode
  • 2: ausgewählt und gesperrt
  • 3: ausgewählt und aktiv
  • 4: nicht unterstützt

Wie du Callback und Enable-Methode schreibst, beschreibt die Hilfe im Thema „Add-in Callback and Enable Methods“: entweder ohne Parameter oder seit SOLIDWORKS 2012 mit einem String-Parameter, etwa "Befehl(1)". Schaltflächen (swToolbarItem) brauchen immer ein Symbol, nur reine Menüeinträge dürfen -1 als ImageListIndex haben. Bei VBA-Add-ins meldest du die Klasse mit den Methoden mit SldWorks.SetAddinCallbackInfo2 an.

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

Siehe auch

Verfügbarkeit

SOLIDWORKS 2007

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

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