SolidWorksMakroprogrammierung

Objekt · SldWorks

TextFormat-Objekt

Das Textformat von Beschriftungen und Skizzentext: Schriftart, Höhe, Fett, Kursiv, Unterstrichen, Abstände, Winkel und Spiegelungen.

Deklaration Dim x As SldWorks.TextFormat · in der englischen .NET-Hilfe: ITextFormat

Beschreibung

TextFormat gibt Zugriff auf die Formatierung von Text in Beschriftungen. Du holst das Format etwa von einer Beschriftung, einer Tabelle oder einem Skizzentext, änderst es und gibst es mit dem passenden Set-Befehl zurück, bei Beschriftungen mit Annotation.SetTextFormat. Für die meisten Eigenschaften nennt die Hilfe keine Version.

Zugriff

Beispiel

' Gibt das Textformat jedes Texts der ausgewählten Beschriftung aus und stellt es
' auf 5 mm hohe, fette Schrift um.
' Vorbedingung: Ein Dokument ist offen, eine Beschriftung mit Text ist ausgewählt,
'               etwa eine Notiz.
' Ergebnis:     Die Beschriftung ist geändert, die alten Werte stehen im Direktfenster.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swSel As Object
    Dim swAnn As SldWorks.Annotation
    Dim swFormat As SldWorks.TextFormat
    Dim i As Long

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Set swSel = swModel.SelectionManager.GetSelectedObject6(1, -1)
    If swSel Is Nothing Then Exit Sub
    Set swAnn = swSel.GetAnnotation                     ' Note, DisplayDimension usw.

    For i = 0 To swAnn.GetTextFormatCount - 1
        Set swFormat = swAnn.GetTextFormat(i)
        Debug.Print "Text " & i & ": " & swFormat.TypeFaceName & ", " & _
                    swFormat.CharHeight * 1000 & " mm, fett " & swFormat.Bold
        swFormat.CharHeight = 0.005
        swFormat.Bold = True
        If False = swAnn.SetTextFormat(i, False, swFormat) Then Debug.Print "  nicht gesetzt"
    Next i
    swModel.ActiveView.GraphicsRedraw Empty
End Sub

Bemerkungen

Ändern: Die Hilfebeispiele „Change Text Format“ und „Increase Width of Text“ geben das geänderte Format mit Annotation.SetTextFormat und False für UseDoc an die Beschriftung zurück. Vermutlich ist TextFormat eine Kopie, die erst damit wirkt. Die Hilfe sagt das nicht ausdrücklich.

Schrifthöhe: Die Höhe gibst du entweder in Metern (TextFormat.CharHeight) oder in Punkt (TextFormat.CharHeightInPts) an. Welche Angabe zuletzt gesetzt wurde, liefert TextFormat.IsHeightSpecifiedInPts.

Einheiten: CharHeight und LineLength sind in Metern, Escapement in Bogenmaß. Für LineSpacing und ObliqueAngle nennt die Hilfe keine Einheit, vermutlich Meter und Bogenmaß.

Eigenschaften und Methoden

Eigenschaften 16, davon 16 beschrieben

NameBeschreibung
BackWardsLiest oder setzt, ob der Text rückwärts (gespiegelt) angezeigt wird.
BoldLiest oder setzt, ob der Text fett ist.
CharHeightLiest oder setzt die Schrifthöhe in Metern.
CharHeightInPtsLiest oder setzt die Schrifthöhe in Punkt.
CharSpacingFactorLiest oder setzt den Faktor für den Abstand zwischen den Zeichen.
EscapementLiest oder setzt den Winkel des Texts.
ItalicLiest oder setzt, ob der Text kursiv ist.
LineLengthLiest oder setzt die Länge einer Textzeile in Metern.
LineSpacingLiest oder setzt den Zeilenabstand des Texts.
ObliqueAngleLiest oder setzt die Neigung des Texts.
StrikeoutLiest oder setzt, ob der Text durchgestrichen ist.
TypeFaceNameLiest oder setzt den Namen der Schriftart.
UnderlineLiest oder setzt, ob der Text unterstrichen ist.
UpsideDownLiest oder setzt, ob der ganze Text auf dem Kopf steht.
VerticalLiest oder setzt, ob die einzelnen Zeichen senkrecht stehen.
WidthFactorLiest oder setzt den Faktor, um den der Text in der Breite gestreckt wird.

Methoden 2, davon 2 beschrieben

NameBeschreibung
GetAllValuesLiefert die Zahlenwerte des Textformats als Array.
IsHeightSpecifiedInPtsLiefert, ob die Schrifthöhe in Punkt oder in Systemeinheiten angegeben ist.

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

Siehe auch

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

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