SolidWorksMakroprogrammierung

Methode · ModelDocExtension

GetUserPreferenceToggle-Methode (ModelDocExtension)

Liest eine Ja/Nein-Einstellung des Dokuments, zum Beispiel ob Ebenen angezeigt werden.

Syntax

Function GetUserPreferenceToggle( _
   ByVal UserPref As Long, _
   ByVal UserPrefOption As Long _
) As Boolean
bAn = swModel.Extension.GetUserPreferenceToggle(UserPref, swDetailingNoOptionSpecified)

Parameter

UserPrefLongByVal
Welche Einstellung, ein Wert aus swUserPreferenceToggle_e, zum Beispiel swDisplayPlanes für „Ebenen anzeigen“.
UserPrefOptionLongByVal
Nur für Einstellungen, die es je Beschriftungs- oder Bemaßungsart einzeln gibt, ein Wert aus swUserPreferenceOption_e. Sonst swDetailingNoOptionSpecified.

Rückgabewert

True, wenn die Einstellung eingeschaltet ist, sonst False.

Beispiel

' Schaltet die Anzeige der Ebenen im aktiven Dokument um: sichtbar wird unsichtbar und umgekehrt.
' Vorbedingung: Ein Teil oder eine Baugruppe ist geöffnet.
' Ergebnis:     Die Ebenen sind ein- bzw. ausgeblendet.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swExt As SldWorks.ModelDocExtension
    Dim bAn As Boolean

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Set swExt = swModel.Extension

    bAn = swExt.GetUserPreferenceToggle(swDisplayPlanes, swDetailingNoOptionSpecified)
    swExt.SetUserPreferenceToggle swDisplayPlanes, swDetailingNoOptionSpecified, Not bAn
End Sub

Bemerkungen

GetUserPreferenceToggle liest Dokumenteigenschaften, also Einstellungen, die mit dem Dokument gespeichert werden. Systemoptionen, die für alle Dokumente gelten, liest SldWorks.GetUserPreferenceToggle. Den Unterschied erklärt ModelDocExtension.SetUserPreferenceToggle.

Typischer Einsatz: Ein Makro ändert eine Einstellung nur vorübergehend. Es liest vorher den alten Wert, ändert die Einstellung und stellt am Ende den alten Wert wieder her.

Der Vorgänger ModelDoc2.GetUserPreferenceToggle ist veraltet.

Siehe auch

Verfügbarkeit

SOLIDWORKS 2009

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

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