SolidWorksMakroprogrammierung

Objekt · SldWorks

PropertyManagerPage2-Objekt

Eine eigene PropertyManager-Seite deines Makros oder Add-ins: Gruppenfelder, Register und Steuerelemente anlegen, Seite anzeigen und schließen, Meldung, Titel, Fokus und Schaltflächen oben auf der Seite.

Deklaration Dim x As SldWorks.PropertyManagerPage2 · in der englischen .NET-Hilfe: IPropertyManagerPage2

Beschreibung

PropertyManagerPage2 erlaubt Makros und Add-ins, eigene Seiten im PropertyManager anzuzeigen, die aussehen und sich bedienen lassen wie die Seiten von SOLIDWORKS. Auf der Seite stehen die Standardsteuerelemente, die SOLIDWORKS selbst verwaltet: Gruppenfelder, Register, Beschriftungen, Schaltflächen, Kontrollkästchen, Optionsfelder, Zahlen-, Text-, Listen-, Kombinations- und Auswahlfelder, Schieberegler, Bilder sowie ActiveX- und .NET-Steuerelemente. Oben hat die Seite die Schaltflächen OK, Abbrechen, Hilfe und auf Wunsch weitere.

So hängt alles zusammen:

VBA: Das geht auch in einem VBA-Makro. Im VBA-Editor hakst du unter Extras › Verweise „SOLIDWORKS <Version> exposed type libraries for add-in use“ an. Dann implementierst du in einem Klassenmodul mit Implements PropertyManagerPage2Handler9 den Handler. VBA verlangt dabei jede Methode der Schnittstelle, auch wenn sie leer bleibt. Die Hilfebeispiele erzeugen die Seite in Class_Initialize der Handler-Klasse und übergeben Me als Handler.

Die Befehle gibt es seit SOLIDWORKS 2001Plus, die neuesten seit 2014 SP01.

Zugriff

Beispiel

' Zeigt eine eigene PropertyManager-Seite mit einem Gruppenfeld, einer Beschriftung,
' einem Schieberegler und einer Schaltfläche.
' Vorbedingung: Ein Dokument ist offen. Im VBA-Editor ist unter Extras › Verweise
'               „SOLIDWORKS <Version> exposed type libraries for add-in use“ angehakt.
'               Im Makro gibt es das Klassenmodul SeitenHandler (Code darunter).
' Ergebnis:     Die Seite erscheint im PropertyManager. Die Schaltfläche und OK schreiben
'               die Stellung des Schiebereglers ins Direktfenster (Strg+G).
Option Explicit

Public swApp As SldWorks.SldWorks
Public oSeite As SeitenHandler                   ' hält die Klasse am Leben, bis die Seite zu ist

Sub main()
    Set swApp = Application.SldWorks
    If swApp.ActiveDoc Is Nothing Then Exit Sub  ' die Seite braucht ein offenes Dokument
    Set oSeite = New SeitenHandler                ' Class_Initialize baut die Seite
    oSeite.Anzeigen
End Sub
Option Explicit

Implements PropertyManagerPage2Handler9

Const ID_GRUPPE As Long = 1                       ' jedes Element braucht eine eigene ID
Const ID_TEXT As Long = 2
Const ID_REGLER As Long = 3
Const ID_KNOPF As Long = 4

Dim swSeite As SldWorks.PropertyManagerPage2
Dim swGruppe As SldWorks.PropertyManagerPageGroup
Dim swText As SldWorks.PropertyManagerPageLabel
Dim swRegler As SldWorks.PropertyManagerPageSlider
Dim swKnopf As SldWorks.PropertyManagerPageButton

Private Sub Class_Initialize()
    Dim nOptionen As Long
    Dim nFehler As Long
    Dim swSteuer As SldWorks.PropertyManagerPageControl

    nOptionen = swPropertyManagerOptions_OkayButton + swPropertyManagerOptions_CancelButton _
              + swPropertyManagerOptions_LockedPage
    Set swSeite = swApp.CreatePropertyManagerPage("Stufe wählen", nOptionen, Me, nFehler)
    If nFehler <> swPropertyManagerPage_Okay Then
        Debug.Print "Seite nicht angelegt, Fehler " & nFehler
        Exit Sub
    End If

    swSeite.SetMessage3 "Stufe einstellen und mit OK bestätigen.", swMessageBoxVisible, _
                        swMessageBoxExpand, "Hinweis"

    Set swGruppe = swSeite.AddGroupBox(ID_GRUPPE, "Einstellungen", _
                                       swGroupBoxOptions_Visible + swGroupBoxOptions_Expanded)
    nOptionen = swControlOptions_Visible + swControlOptions_Enabled
    Set swText = swGruppe.AddControl2(ID_TEXT, swControlType_Label, "Stufe (0 bis 10):", _
                                      swControlAlign_LeftEdge, nOptionen, "")
    Set swRegler = swGruppe.AddControl2(ID_REGLER, swControlType_Slider, "", _
                                        swControlAlign_Indent, nOptionen, "Stufe")
    swRegler.SetRange 0, 10
    swRegler.Position = 5
    Set swKnopf = swGruppe.AddControl2(ID_KNOPF, swControlType_Button, "Ausgeben", _
                                       swControlAlign_Indent, nOptionen, "Stufe ausgeben")

    Set swSteuer = swRegler                       ' derselbe Schieberegler als PropertyManagerPageControl
    swSteuer.Tip = "Stufe mit der Maus oder den Pfeiltasten wählen"
End Sub

Public Sub Anzeigen()
    If Not swSeite Is Nothing Then swSeite.Show2 0
End Sub

' ---- Handler: VBA verlangt jede Methode von PropertyManagerPage2Handler9 ----

Private Sub PropertyManagerPage2Handler9_OnButtonPress(ByVal Id As Long)
    If Id = ID_KNOPF Then Debug.Print "Stufe: " & swRegler.Position
End Sub

Private Sub PropertyManagerPage2Handler9_OnClose(ByVal Reason As Long)
    ' Werte hier lesen: Nach dem Schließen gibt es die Steuerelemente nicht mehr.
    If Reason = swPropertyManagerPageClose_Okay Then Debug.Print "OK mit Stufe " & swRegler.Position
End Sub

Private Sub PropertyManagerPage2Handler9_AfterClose()
    Set oSeite = Nothing                          ' Klasse freigeben, wie im Hilfebeispiel
End Sub

Private Sub PropertyManagerPage2Handler9_AfterActivation()
End Sub
Private Function PropertyManagerPage2Handler9_OnActiveXControlCreated(ByVal Id As Long, ByVal Status As Boolean) As Long
End Function
Private Sub PropertyManagerPage2Handler9_OnCheckboxCheck(ByVal Id As Long, ByVal Checked As Boolean)
End Sub
Private Sub PropertyManagerPage2Handler9_OnComboboxEditChanged(ByVal Id As Long, ByVal Text As String)
End Sub
Private Sub PropertyManagerPage2Handler9_OnComboboxSelectionChanged(ByVal Id As Long, ByVal Item As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnGainedFocus(ByVal Id As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnGroupCheck(ByVal Id As Long, ByVal Checked As Boolean)
End Sub
Private Sub PropertyManagerPage2Handler9_OnGroupExpand(ByVal Id As Long, ByVal Expanded As Boolean)
End Sub
Private Function PropertyManagerPage2Handler9_OnHelp() As Boolean
End Function
Private Function PropertyManagerPage2Handler9_OnKeystroke(ByVal Wparam As Long, ByVal Message As Long, ByVal Lparam As Long, ByVal Id As Long) As Boolean
End Function
Private Sub PropertyManagerPage2Handler9_OnListboxRMBUp(ByVal Id As Long, ByVal PosX As Long, ByVal PosY As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnListboxSelectionChanged(ByVal Id As Long, ByVal Item As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnLostFocus(ByVal Id As Long)
End Sub
Private Function PropertyManagerPage2Handler9_OnNextPage() As Boolean
End Function
Private Sub PropertyManagerPage2Handler9_OnNumberBoxTrackingCompleted(ByVal Id As Long, ByVal Value As Double)
End Sub
Private Sub PropertyManagerPage2Handler9_OnNumberboxChanged(ByVal Id As Long, ByVal Value As Double)
End Sub
Private Sub PropertyManagerPage2Handler9_OnOptionCheck(ByVal Id As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnPopupMenuItem(ByVal Id As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnPopupMenuItemUpdate(ByVal Id As Long, retval As Long)
End Sub
Private Function PropertyManagerPage2Handler9_OnPreview() As Boolean
End Function
Private Function PropertyManagerPage2Handler9_OnPreviousPage() As Boolean
End Function
Private Sub PropertyManagerPage2Handler9_OnRedo()
End Sub
Private Sub PropertyManagerPage2Handler9_OnSelectionboxCalloutCreated(ByVal Id As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnSelectionboxCalloutDestroyed(ByVal Id As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnSelectionboxFocusChanged(ByVal Id As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnSelectionboxListChanged(ByVal Id As Long, ByVal Count As Long)
End Sub
Private Sub PropertyManagerPage2Handler9_OnSliderPositionChanged(ByVal Id As Long, ByVal Value As Double)
End Sub
Private Sub PropertyManagerPage2Handler9_OnSliderTrackingCompleted(ByVal Id As Long, ByVal Value As Double)
End Sub
Private Function PropertyManagerPage2Handler9_OnSubmitSelection(ByVal Id As Long, ByVal Selection As Object, ByVal SelType As Long, ItemText As String) As Boolean
    PropertyManagerPage2Handler9_OnSubmitSelection = True     ' Auswahl annehmen
End Function
Private Function PropertyManagerPage2Handler9_OnTabClicked(ByVal Id As Long) As Boolean
End Function
Private Sub PropertyManagerPage2Handler9_OnTextboxChanged(ByVal Id As Long, ByVal Text As String)
End Sub
Private Sub PropertyManagerPage2Handler9_OnUndo()
End Sub
Private Sub PropertyManagerPage2Handler9_OnWhatsNew()
End Sub
Private Function PropertyManagerPage2Handler9_OnWindowFromHandleControlCreated(ByVal Id As Long, ByVal Status As Boolean) As Long
End Function

Bemerkungen

Zwei Zustände: Die Seite gibt es unsichtbar und sichtbar. Solange sie nicht angezeigt wird, gibt es kein Fenster, nur die API-Objekte mit den Vorgaben, die du gesetzt hast. Wird sie angezeigt, stehen die Objekte für die Steuerelemente im Fenster, und ihre Werte sind die aktuellen Einstellungen. Hat der Benutzer die Seite geschlossen, kannst du seine Eingaben nicht mehr lesen. Lies sie deshalb, solange die Seite offen ist, spätestens in OnClose. Gruppenfelder, Register und Steuerelemente legst du an, solange die Seite nicht angezeigt wird.

Gesperrte Seite: Lege die Seite wie bei SldWorks.CreatePropertyManagerPage beschrieben mit swPropertyManagerOptions_LockedPage an. Ist die Seite nicht mehr da, wenn ein Handler wie OnButtonPress oder OnClose fertig ist, kann SOLIDWORKS abstürzen.

Schließen: SOLIDWORKS schließt die Seite, wenn der Benutzer OK oder Abbrechen klickt, das Objekt PropertyManagerPage2 bleibt aber bestehen. Den Grund meldet OnClose mit einem Wert aus swPropertyManagerPageCloseReasons_e. Bei OnClose kann das Makro keine eigentliche Arbeit mehr tun, dafür ist AfterClose da.

Grenzen: Auf eine Seite passen höchstens 300 Steuerelemente, 20 Gruppenfelder und 15 Auswahlfelder. Ein Zahlenfeld zählt doppelt, Gruppenfelder und Auswahlfelder zählen nicht zu den 300. In ein Gruppenfeld passen nach PropertyManagerPageGroup höchstens 15 Steuerelemente. Steuerelemente stehen in einer linksbündigen Spalte.

Mehrere Seiten: Bei einer mehrseitigen Seite (swPropertyManagerOptions_MultiplePages) stehen alle Steuerelemente auf einer einzigen Seite. Beim Blättern blendest du in OnNextPage und OnPreviousPage die passenden Steuerelemente ein und die anderen aus. Zeig dort keine zweite Seite an, sonst schließt die erste und es kommt zu einem Speicherfehler.

Hilfe-Schaltfläche: Es gibt sie immer. Gibt OnHelp False zurück, erscheint die SOLIDWORKS-Hilfe.

Sonst: Solange die Seite offen ist, lassen sich keine Komponenten oder Features unterdrücken. Die Farbe der Trennbalken für eigene Bilder liefert ModelDocExtension.GetUserPreferenceInteger mit swPropertyManagerColorDivider. Den Namen der gerade offenen Seite liefert ModelDocExtension.GetActivePropertyManagerPage.

Hilfebeispiele: „Create PropertyManager Page“ zeigt alle Arten von Steuerelementen mit einem Register. Die Hilfebeispiele mischen in den Optionen von CreatePropertyManagerPage Werte aus swPropertyManagerButtonTypes_e (swPropertyManager_OkayButton) und swPropertyManagerPageOptions_e. Für CreatePropertyManagerPage gilt swPropertyManagerPageOptions_e. Die Pinnadel hat dort einen anderen Wert, das Beispiel oben nimmt deshalb nur Werte aus swPropertyManagerPageOptions_e.

Eigenschaften und Methoden

Eigenschaften 2, davon 2 beschrieben

NameBeschreibung
PinnedLiest oder setzt, ob die Pinnadel der PropertyManager-Seite gedrückt ist, die Seite also nach OK offen bleibt.
TitleLiest oder setzt den Titel der PropertyManager-Seite.

Methoden 19, davon 12 beschrieben, 7 veraltet

NameBeschreibung
AddControlveraltet ersetzt durch PropertyManagerPage2.AddControl2
AddControl2Setzt ein Steuerelement direkt auf die PropertyManager-Seite, ohne Gruppenfeld.
AddGroupBoxSetzt ein neues Gruppenfeld auf die PropertyManager-Seite, in das du dann Steuerelemente setzt.
AddMenuPopupItemFügt dem Kontextmenü, solange die PropertyManager-Seite offen ist, einen eigenen Eintrag hinzu.
AddTabSetzt ein neues Register auf die PropertyManager-Seite, mit Text und auf Wunsch einem Bild.
CloseSchließt die PropertyManager-Seite wie mit OK oder wie mit Abbrechen.
EnableButtonSchaltet eine Schaltfläche oben auf der PropertyManager-Seite aktiv oder inaktiv, etwa Weiter oder Zurück.
GetFocusLiefert die ID des Steuerelements, das auf der PropertyManager-Seite gerade den Fokus hat.
SetCursorLegt fest, was nach einer Auswahl im Grafikbereich passiert: ins nächste Auswahlfeld wechseln oder die Seite mit OK schließen.
SetExitConfirmationCursorveraltet ersetzt durch PropertyManagerPage2.SetCursor
SetFocusSetzt den Fokus auf ein Steuerelement der PropertyManager-Seite.
SetMessageveraltet ersetzt durch PropertyManagerPage2.SetMessage3
SetMessage2veraltet ersetzt durch PropertyManagerPage2.SetMessage3
SetMessage3Setzt die Meldung oben auf der PropertyManager-Seite: Text, Überschrift, Sichtbarkeit und ob sie aufgeklappt ist.
SetTitleBitmapveraltet ersetzt durch PropertyManagerPage2.SetTitleBitmapx64
SetTitleBitmap2veraltet ersetzt durch PropertyManagerPage2.SetTitleBitmapx64
SetTitleBitmapx64Setzt ein Bild links in der Titelleiste der PropertyManager-Seite, aus den Ressourcen eines Add-ins.
Showveraltet ersetzt durch PropertyManagerPage2.Show2
Show2Zeigt die PropertyManager-Seite an, auf Wunsch gestapelt über einer anderen Seite.

Nicht aufgeführt sind 2 C++-Varianten (Namen mit I davor, zum Beispiel IAddControl). In VBA nimmst du immer den Befehl ohne I.

Siehe auch

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

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