SolidWorksMakroprogrammierung

Methode · ModelDocExtension

GetUserPreferenceInteger-Methode (ModelDocExtension)

Liest eine Zahlen-Einstellung des Dokuments, zum Beispiel das Einheitensystem.

Syntax

Function GetUserPreferenceInteger( _
   ByVal UserPref As Long, _
   ByVal UserPrefOption As Long _
) As Long
nWert = swModel.Extension.GetUserPreferenceInteger(UserPref, swDetailingNoOptionSpecified)

Parameter

UserPrefLongByVal
Welche Einstellung, ein Wert aus swUserPreferenceIntegerValue_e, zum Beispiel swUnitSystem für das Einheitensystem.
UserPrefOptionLongByVal
Nur für Einstellungen, die es je Beschriftungs- oder Bemaßungsart einzeln gibt, ein Wert aus swUserPreferenceOption_e. Sonst swDetailingNoOptionSpecified.

Rückgabewert

Der Wert der Einstellung. Bei Einstellungen mit festen Möglichkeiten ein Wert aus der passenden Enumeration, beim Einheitensystem etwa aus swUnitSystem_e.

Beispiel

' Zeigt, welches Einheitensystem das aktive Dokument verwendet.
' Vorbedingung: Ein Dokument ist geöffnet.
' Ergebnis:     Meldung mit dem Einheitensystem.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim sSystem As String

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

    Select Case swModel.Extension.GetUserPreferenceInteger(swUnitSystem, swDetailingNoOptionSpecified)
        Case swUnitSystem_MMGS:   sSystem = "MMGS (Millimeter, Gramm, Sekunde)"
        Case swUnitSystem_CGS:    sSystem = "CGS (Zentimeter, Gramm, Sekunde)"
        Case swUnitSystem_MKS:    sSystem = "MKS (Meter, Kilogramm, Sekunde)"
        Case swUnitSystem_IPS:    sSystem = "IPS (Zoll, Pfund, Sekunde)"
        Case swUnitSystem_Custom: sSystem = "Benutzerdefiniert"
    End Select

    swApp.SendMsgToUser2 "Einheitensystem: " & sSystem, swMbInformation, swMbOk
End Sub

Bemerkungen

GetUserPreferenceInteger liest Dokumenteigenschaften. Systemoptionen, die für alle Dokumente gelten, liest SldWorks.GetUserPreferenceIntegerValue. Den Unterschied erklärt ModelDocExtension.SetUserPreferenceToggle.

Das Einheitensystem betrifft nur die Anzeige in SOLIDWORKS. Die API rechnet bei Längen immer in Metern, etwa bei ModelDoc2.SketchManager. Nur einzelne Befehle wie Dimension.GetValue3 liefern Werte in der Einheit des Dokuments. Bevor ein Makro solche Werte anzeigt oder umrechnet, kann es mit GetUserPreferenceInteger prüfen, welche Einheit eingestellt ist.

Siehe auch

Verfügbarkeit

SOLIDWORKS 2009

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

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