SolidWorksMakroprogrammierung

Objekt · SldWorks

FlyoutGroup-Objekt

Ein Flyout eines Add-ins: eine Schaltfläche mit aufklappender Befehlsliste im CommandManager und in Kontextmenüs.

Deklaration Dim x As SldWorks.FlyoutGroup · in der englischen .NET-Hilfe: IFlyoutGroup

Beschreibung

FlyoutGroup gibt Zugriff auf ein Flyout-Menü. Es steht für eine Gruppe von Flyout-Befehlen, die erscheinen, wenn im Modell ein bestimmtes Element ausgewählt ist. Ein Add-in legt das Flyout mit CommandManager.CreateFlyoutGroup2 an. Die Einträge fügt es erst zur Laufzeit hinzu, in der Callback-Methode des Flyouts. Wie die Befehlsgruppe (CommandGroup) gibt es das Flyout nur in Add-ins. Die meisten Befehle gibt es seit SOLIDWORKS 2011.

Zugriff

Beispiel

' Legt beim Laden des Add-ins ein Flyout an, zeigt es im Kontextmenü von Flächen in Teilen
' und füllt es beim Aufklappen mit zwei Einträgen. Beim Entladen wird es 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:     Nach dem Laden des Add-ins hat das Kontextmenü einer Fläche das Flyout mit
'               den Einträgen „Befehl 1“ und „Befehl 2“.
Option Explicit

Implements SwAddin

Private swApp As SldWorks.SldWorks
Private swCmdMgr As SldWorks.CommandManager
Private nCookie As Long
Private Const FLYOUT_ID As Long = 30                       ' eigene, eindeutige ID des Flyouts

Private Function SwAddin_ConnectToSW(ByVal ThisSW As Object, ByVal Cookie As Long) As Boolean
    Dim swFlyout As SldWorks.FlyoutGroup
    Dim aHaupt(0) As String, aSymbole(0) As String

    Set swApp = ThisSW
    nCookie = Cookie
    swApp.SetAddinCallbackInfo2 0, Me, nCookie               ' diese Klasse enthält die Callbacks
    Set swCmdMgr = swApp.GetCommandManager(nCookie)

    aHaupt(0) = "C:\Werkzeuge\Flyout_20.png"                 ' ein Symbol
    aSymbole(0) = "C:\Werkzeuge\FlyoutSymbole_20.png"        ' alle Einträge nebeneinander
    Set swFlyout = swCmdMgr.CreateFlyoutGroup2(FLYOUT_ID, "Werkzeuge", "Eigene Werkzeuge", "Werkzeuge für Flächen", _
                                               aHaupt, aSymbole, "FlyoutKlick", "FlyoutAktiv")
    If swFlyout Is Nothing Then Exit Function
    swFlyout.FlyoutType = swCommandFlyoutStyle_Simple        ' Kontextmenüs können nur diesen Stil
    swFlyout.AddContextMenuFlyout swDocPART, swSelFACES
    SwAddin_ConnectToSW = True
End Function

Private Function SwAddin_DisconnectFromSW() As Boolean
    swCmdMgr.RemoveFlyoutGroup FLYOUT_ID
    Set swCmdMgr = Nothing
    Set swApp = Nothing
    SwAddin_DisconnectFromSW = True
End Function

Public Sub FlyoutKlick()                                     ' Callback des Flyouts: Einträge zur Laufzeit
    Dim swFlyout As SldWorks.FlyoutGroup
    Set swFlyout = swCmdMgr.GetFlyoutGroup(FLYOUT_ID)
    swFlyout.RemoveAllCommandItems
    swFlyout.AddCommandItem "Befehl 1", "Erster Befehl", 0, "Befehl1", "BefehlAktiv"
    swFlyout.AddCommandItem "Befehl 2", "Zweiter Befehl", 1, "Befehl2", "BefehlAktiv"
End Sub

Public Function FlyoutAktiv() As Long                        ' Enable-Methode des Flyouts: 1 = aktiv
    FlyoutAktiv = 1
End Function

Public Sub Befehl1()
    swApp.SendMsgToUser2 "Befehl 1", swMbInformation, swMbOk
End Sub

Public Sub Befehl2()
    swApp.SendMsgToUser2 "Befehl 2", swMbInformation, swMbOk
End Sub

Public Function BefehlAktiv() As Long                        ' Enable-Methode der Einträge
    If swApp.ActiveDoc Is Nothing Then BefehlAktiv = 0 Else BefehlAktiv = 1
End Function

Bemerkungen

Hilfebeispiel: „Create Flyouts in the CommandManager“ gibt es nur in C# und VB.NET. Das Add-in legt ein Flyout an, fügt es mit FlyoutGroup.AddContextMenuFlyout dem Kontextmenü von Flächen in Teilen hinzu und legt es mit FlyoutGroup.CmdID und CommandTabBox.AddCommands auf eine Registerkarte. In der Callback-Methode des Flyouts leert es die Liste mit FlyoutGroup.RemoveAllCommandItems, fügt zwei Einträge mit FlyoutGroup.AddCommandItem hinzu und setzt FlyoutGroup.FlyoutType auf swCommandFlyoutStyle_LastUsed. Die Enable-Methode des Flyouts fragt dort CommandGroup.HasEnabledButton ab.

Das Beispiel oben folgt diesen Beispielen und der Befehlsgruppe (CommandGroup). Ob 0 als ModuleHandle bei SldWorks.SetAddinCallbackInfo2 reicht, sagt die Hilfe nicht. Ob das Flyout im Kontextmenü auch ohne Registerkarte erscheint, ist nicht belegt.

Veraltete Befehle: LargeIconList, SmallIconList, LargeMainIcon und SmallMainIcon sind veraltet. An ihre Stelle treten FlyoutGroup.IconList und FlyoutGroup.MainIconList.

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

Eigenschaften und Methoden

Eigenschaften 9, davon 5 beschrieben, 4 veraltet

NameBeschreibung
ButtonCountLiefert die Zahl der Schaltflächen im Flyout.
CmdIDLiefert die Befehls-ID des Flyouts, etwa um es auf eine Registerkarte zu legen.
FlyoutTypeLiest oder setzt, was ein Klick auf die Hauptschaltfläche des Flyouts tut.
IconListLiest oder setzt die Bilddateien mit den Symbolen aller Einträge des Flyouts, je Größe eine Datei.
LargeIconListveraltet ersetzt durch FlyoutGroup.IconList
LargeMainIconveraltet ersetzt durch FlyoutGroup.MainIconList
MainIconListLiest oder setzt die Bilddateien mit dem Symbol der Hauptschaltfläche des Flyouts, je Größe eine Datei.
SmallIconListveraltet ersetzt durch FlyoutGroup.IconList
SmallMainIconveraltet ersetzt durch FlyoutGroup.MainIconList

Methoden 5, davon 5 beschrieben

NameBeschreibung
AddCommandItemFügt dem Flyout einen Eintrag hinzu.
AddContextMenuFlyoutFügt das Flyout den Kontextmenüs einer Dokumentart und einer Auswahlart hinzu.
RemoveAllCommandItemsEntfernt alle Einträge aus dem Flyout.
RemoveCommandItemEntfernt den Eintrag an einer Stelle des Flyouts.
ReplaceCommandItemErsetzt den Eintrag an einer Stelle des Flyouts durch einen neuen.

Siehe auch

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

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