SolidWorksMakroprogrammierung

Methode · FlyoutGroup

AddCommandItem-Methode (FlyoutGroup)

Fügt dem Flyout einen Eintrag hinzu.

Syntax

Function AddCommandItem( _
   ByVal Name As String, _
   ByVal HintString As String, _
   ByVal ImageListIndex As Long, _
   ByVal CallbackFunction As String, _
   ByVal UpdateCallbackFunction As String _
) As Long
nIndex = swFlyout.AddCommandItem("Befehl 1", "Erster Befehl", 0, "Befehl1", "BefehlAktiv")

Parameter

NameStringByVal
Der Name des Eintrags.
HintStringStringByVal
Der Text in der Statusleiste, wenn der Mauszeiger auf dem Eintrag steht.
ImageListIndexLongByVal
Die Nummer des Symbols in den Bildern des Flyouts (FlyoutGroup.IconList), ab 0.
CallbackFunctionStringByVal
Der Name der Methode, die SOLIDWORKS beim Klick auf den Eintrag aufruft.
UpdateCallbackFunctionStringByVal
Optional der Name der Methode, die den Zustand des Eintrags liefert (siehe Bemerkungen), sonst eine leere Zeichenkette.

Rückgabewert

Der Index des Eintrags im Flyout, von SOLIDWORKS vergeben.

Beispiel

' Im Add-in: swCmdMgr ist der CommandManager, 30 die eigene ID des Flyouts,
' FlyoutKlick die CallbackFunction aus CreateFlyoutGroup2.
Public Sub FlyoutKlick()
    Dim swFlyout As SldWorks.FlyoutGroup
    Set swFlyout = swCmdMgr.GetFlyoutGroup(30)
    swFlyout.RemoveAllCommandItems
    swFlyout.AddCommandItem "Befehl 1", "Erster Befehl", 0, "Befehl1", "BefehlAktiv"
End Sub

' In derselben Klasse:
Public Sub Befehl1()
    swApp.SendMsgToUser2 "Befehl 1", swMbInformation, swMbOk
End Sub

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

Bemerkungen

Flyouts entstehen zur Laufzeit: Du rufst AddCommandItem in der Callback-Methode auf, die du bei CommandManager.CreateFlyoutGroup2 angegeben hast. So macht es das Hilfebeispiel „Create Flyouts in the CommandManager“, vorher leert es die Liste mit FlyoutGroup.RemoveAllCommandItems.

Die Update-Methode liefert einen dieser Werte:

  • 0: abgewählt und gesperrt
  • 1: abgewählt und aktiv, so ist es auch ohne Update-Methode
  • 2: ausgewählt und gesperrt
  • 3: ausgewählt und aktiv
  • 4: Eintrag ausgeblendet

Wie du Callback und Update-Methode schreibst, beschreibt die Hilfe im Thema „Add-in Callback and Enable Methods“, siehe auch CommandGroup.AddCommandItem2. Für ImageListIndex verweist die Hilfe noch auf die veralteten LargeIconList und SmallIconList. Gemeint sind heute vermutlich die Bilder aus FlyoutGroup.IconList.

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

Siehe auch

Verfügbarkeit

SOLIDWORKS 2011

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

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