SolidWorksMakroprogrammierung

Objekt · SldWorks

UserUnit-Objekt

Die Längen- oder Winkeleinheit eines Dokuments mit ihren Anzeigeeinstellungen, dazu Umrechnungen zwischen Text, Dokumenteinheit und Systemwert.

Deklaration Dim x As SldWorks.UserUnit · in der englischen .NET-Hilfe: IUserUnit

Beschreibung

UserUnit dient dazu, Einheiten zu verwalten. Ein UserUnit-Objekt steht entweder für die Längen- oder für die Winkeleinheit (UserUnit.UnitType). Es kennt die genaue Einheit, etwa Millimeter oder Grad, die Anzeige mit Nachkommastellen, Brüchen und Dezimaltrennzeichen und rechnet Werte um. Die Befehle gibt es seit SOLIDWORKS 2001.

Zugriff

  • ModelDoc2.GetUserUnit: die Einheit eines Dokuments. Die Eigenschaften sind dann nur lesbar.
  • SldWorks.GetUserUnit: ein leeres Objekt, das zu keinem Dokument gehört. Die Eigenschaften sind les- und schreibbar, werden aber nicht gespeichert.

Beispiel

' Gibt die Längeneinheit des aktiven Dokuments mit ihren Einstellungen aus, zeigt
' 25,4 mm in der Dokumenteinheit und liest einen Ausdruck wie in einem Eingabefeld.
' Vorbedingung: Ein Teil, eine Baugruppe oder eine Zeichnung ist offen.
' Ergebnis:     Die Angaben stehen im Direktfenster.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swEinheit As SldWorks.UserUnit
    Dim dWert As Double

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

    Set swEinheit = swModel.GetUserUnit(swLengthUnit)
    Debug.Print "Einheit: " & swEinheit.GetFullUnitName(True) & " (" & swEinheit.GetUnitsString(False) & ")"
    Debug.Print "Metrisch: " & swEinheit.IsMetric & ", Nachkommastellen: " & swEinheit.SignificantDigits & _
                ", Trennzeichen: " & swEinheit.SeparatorCharacter
    If swEinheit.SpecificUnitType = swMM Then Debug.Print "Das Dokument rechnet in Millimeter."

    Debug.Print "0,0254 m = " & swEinheit.ConvertToUserUnit(0.0254, True, False)
    If swEinheit.ConvertToSystemValue("10 / 2", dWert) Then
        Debug.Print "Eingabe 10 / 2 ergibt " & dWert
    End If
End Sub

Bemerkungen

Lesen und Ändern: Von ModelDoc2.GetUserUnit sind die Eigenschaften nur lesbar. Die Einheiten eines Dokuments änderst du mit den SetUserPreference-Befehlen, etwa ModelDocExtension.SetUserPreferenceInteger. Das Hilfebeispiel „Get and Set Document Units“ liest alle Eigenschaften der Winkeleinheit und stellt danach mit swUnitsAngular und swUnitsAngularDecimalPlaces aus swUserPreferenceIntegerValue_e Grad, Minuten, Sekunden mit zwei Nachkommastellen ein.

Umrechnungen: Die Hilfe beschreibt die Richtung der Umrechnungen ungenau. Sie nennt das Ergebnis von ConvertDoubleToSystemValue und ConvertToSystemValue einen Wert „in Dokumenteinheiten“, die Namen sprechen vom Systemwert. Gemeint ist der Systemwert, also Meter oder Bogenmaß („10 / 2“ in der Längeneinheit mm ergab 0,005, 2 in der Winkeleinheit Grad ergab 0,0349).

Hinweis der Hilfe: UserUnit ersetzt die Datei mo_UserUnits.h im Ordner appcomm der SOLIDWORKS-Installation. Programme, die diese Datei benutzt haben, sollen auf UserUnit umgestellt werden.

Eigenschaften und Methoden

Eigenschaften 9, davon 9 beschrieben

NameBeschreibung
DisplayLeadingZeroLiefert, ob vor dem Dezimaltrennzeichen eine Null angezeigt wird, also 0,5 statt ,5.
FractionBaseLiefert, ob Werte als Dezimalzahl oder als Bruch angezeigt werden.
FractionValueLiefert den Nenner der Brüche, mit denen Werte angezeigt werden.
PadZeroLiefert, ob Werte mit Nullen auf die volle Zahl der Nachkommastellen aufgefüllt werden.
RoundToFractionLiefert, ob Werte auf den nächsten Bruch gerundet werden.
SeparatorCharacterLiefert das Dezimaltrennzeichen der Einheit.
SignificantDigitsLiefert die Zahl der Nachkommastellen der Einheit.
SpecificUnitTypeLiefert die genaue Einheit, etwa Millimeter oder Grad.
UnitTypeLiefert, ob das Objekt für die Längen- oder die Winkeleinheit steht.

Methoden 8, davon 8 beschrieben

NameBeschreibung
ConvertDoubleToSystemValueRechnet eine Zahl in der Einheit des Objekts um, in einen Wert in Dokumenteinheiten.
ConvertToSystemValueLiest einen Text wie in einem Eingabefeld, auch mit Rechenausdruck, und liefert den Zahlenwert.
ConvertToUserUnitGibt einen Wert als Text in der Einheit des Objekts aus, auf Wunsch mit Einheitenname.
GetConversionFactorLiefert den Umrechnungsfaktor der Einheit.
GetFullUnitNameLiefert den vollen Namen der Einheit, in Einzahl oder Mehrzahl.
GetUnitsStringLiefert den Text, der die Einheit beschreibt, etwa das Kürzel.
GetUserAngleToleranceLiefert die Winkeltoleranz einer Winkeleinheit.
IsMetricLiefert, ob die Einheit metrisch ist.

Siehe auch

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

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