SolidWorksMakroprogrammierung

Methode · ModelDocExtension

SetUserPreferenceInteger-Methode (ModelDocExtension)

Setzt eine Zahlen-Einstellung des Dokuments, zum Beispiel das Einheitensystem oder die Zahl der Nachkommastellen.

Syntax

Function SetUserPreferenceInteger( _
   ByVal UserPref As Long, _
   ByVal UserPrefOption As Long, _
   ByVal Value As Long _
) As Boolean
bErfolg = swModel.Extension.SetUserPreferenceInteger(UserPref, swDetailingNoOptionSpecified, Value)

Parameter

UserPrefLongByVal

Welche Einstellung, ein Wert aus swUserPreferenceIntegerValue_e, zum Beispiel:

  • swUnitSystem: Einheitensystem, Werte aus swUnitSystem_e
  • swUnitsLinearDecimalPlaces: Nachkommastellen für Längen, 0 bis 8
UserPrefOptionLongByVal
Nur für Einstellungen, die es je Beschriftungs- oder Bemaßungsart einzeln gibt, ein Wert aus swUserPreferenceOption_e. Sonst swDetailingNoOptionSpecified.
ValueLongByVal
Der neue Wert. Bei Einstellungen mit festen Möglichkeiten ein Wert aus der passenden Enumeration, beim Einheitensystem etwa swUnitSystem_MMGS.

Rückgabewert

True, wenn die Einstellung gesetzt wurde, sonst False.

Beispiel

' Stellt das aktive Dokument auf Millimeter, Gramm, Sekunde mit zwei Nachkommastellen.
' Vorbedingung: Ein Teil, eine Baugruppe oder eine Zeichnung ist geöffnet.
' Ergebnis:     Unter Extras › Optionen › Dokumenteigenschaften › Einheiten steht MMGS.
Option Explicit

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

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

    If False = swExt.SetUserPreferenceInteger(swUnitSystem, swDetailingNoOptionSpecified, swUnitSystem_MMGS) Then
        swApp.SendMsgToUser2 "Einheitensystem nicht gesetzt.", swMbWarning, swMbOk
        Exit Sub
    End If
    swExt.SetUserPreferenceInteger swUnitsLinearDecimalPlaces, swDetailingNoOptionSpecified, 2
    swModel.EditRebuild3
End Sub

Bemerkungen

Dieser Befehl ändert Dokumenteigenschaften, also Einstellungen, die mit dem Dokument gespeichert werden. Systemoptionen wie die STEP-Version beim Export gelten dagegen für alle Dokumente und laufen über SldWorks.SetUserPreferenceIntegerValue. Welcher Wert wohin gehört, steht in der englischen Hilfe auf den Seiten „System Options and Document Properties“.

Manche Einheiten-Einstellungen lassen sich nur setzen, wenn das Einheitensystem swUnitSystem_Custom ist, etwa die Masseneinheit für die Masseneigenschaften. Sonst liefert der Befehl False.

Die Vorgänger ModelDoc2.SetUserPreferenceIntegerValue und ModelDoc2.GetUserPreferenceIntegerValue sind veraltet.

Siehe auch

Verfügbarkeit

SOLIDWORKS 2009

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

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