SolidWorksMakroprogrammierung

Objekt · SldWorks

Paragraphs-Objekt

Die Absätze einer Notiz: Text, Textabschnitte mit eigenem Format, Aufzählung und Nummerierung, Einzüge sowie Absatz- und Zeilenabstand.

Deklaration Dim x As SldWorks.Paragraphs · in der englischen .NET-Hilfe: IParagraphs

Beschreibung

Paragraphs gibt Zugriff auf die Absätze in Notizen. Ein Paragraphs-Objekt steht für alle Absätze einer Notiz. Du wählst mit Paragraphs.CurrentParagraph einen Absatz aus, liest oder änderst seine Werte und übernimmst Änderungen mit Paragraphs.UpdateParagraph ins Modell. Die Befehle gibt es seit SOLIDWORKS 2016.

Zugriff

Beispiel

' Gibt für jeden Absatz der ausgewählten Notiz Text, Listenart, Einzüge und
' Abstände aus, listet die Textabschnitte auf und setzt sie fett.
' Vorbedingung: Ein Dokument ist offen, eine Notiz mit Text ist ausgewählt.
' Ergebnis:     Die Werte stehen im Direktfenster (Strg+G), der Text der Notiz
'               ist fett.
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swSelMgr As SldWorks.SelectionMgr
    Dim swNote As SldWorks.Note
    Dim swAnn As SldWorks.Annotation
    Dim swAbsaetze As SldWorks.Paragraphs
    Dim swFormat As SldWorks.TextFormat
    Dim nArt As Long, nRichtung As Long, nStart As Long, nTyp As Long, nFormat As Long
    Dim dErste As Double, dEinzug As Double, dSchritt As Double
    Dim dAbsatz As Double, dZeile As Double
    Dim i As Long, j As Long

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    Set swSelMgr = swModel.SelectionManager
    If swSelMgr.GetSelectedObjectType3(1, -1) <> swSelNOTES Then Exit Sub
    Set swNote = swSelMgr.GetSelectedObject6(1, -1)
    Set swAnn = swNote.GetAnnotation
    Set swAbsaetze = swAnn.GetParagraphs
    If swAbsaetze Is Nothing Then Exit Sub

    For i = 0 To swAbsaetze.Count - 1
        swAbsaetze.CurrentParagraph = i
        Debug.Print "Absatz " & i & ": " & swAbsaetze.GetText(False)
        swAbsaetze.GetBulletsAndNumbering nArt, nRichtung, nStart, nTyp, nFormat
        Debug.Print "  Listenart: " & nArt                  ' Wert aus swParagraphType_e
        swAbsaetze.GetIndentation dErste, dEinzug, dSchritt
        Debug.Print "  Einzug erste Zeile: " & dErste & ", übrige Zeilen: " & dEinzug
        swAbsaetze.GetFormatting dAbsatz, dZeile
        Debug.Print "  Absatzabstand: " & dAbsatz & ", Zeilenabstand: " & dZeile
        For j = 0 To swAbsaetze.GetTextSegmentCount - 1
            Set swFormat = swAbsaetze.GetTextSegmentFormat(j)
            Debug.Print "  Abschnitt " & j & ": """ & swAbsaetze.GetTextSegmentText(j) & _
                """ in " & swFormat.TypeFaceName
            swFormat.Bold = True
            swAbsaetze.SetTextSegmentFormat j, swFormat
        Next j
        swAbsaetze.UpdateParagraph
    Next i
    swModel.ActiveView.GraphicsRedraw Empty
End Sub

Bemerkungen

Aktueller Absatz: Setze vor jedem anderen Befehl von Paragraphs den aktuellen Absatz mit Paragraphs.CurrentParagraph. Der Index beginnt bei 0, die Zahl der Absätze liefert Paragraphs.Count.

Ändern: Nach Paragraphs.SetBulletsAndNumbering, Paragraphs.SetFormatting, Paragraphs.SetIndentation und Paragraphs.SetTextSegmentFormat rufst du Paragraphs.UpdateParagraph auf, damit das Modell die Änderungen übernimmt. Das Hilfebeispiel „Get and Set Paragraph Properties“ ändert so in jedem Absatz einer ausgewählten Notiz die Abstände und setzt alle Textabschnitte fett. Danach zeichnet es den Grafikbereich neu.

Textabschnitte: Ein Absatz besteht aus einem oder mehreren Textabschnitten (text segments), jeder mit einem anderen Format. Der Index der Textabschnitte beginnt ebenfalls bei 0.

Einheiten: Für Abstände und Einzüge nennt die Hilfe keine Einheit. Das Hilfebeispiel setzt Absatz- und Zeilenabstand auf Werte wie 0,0011 und 0,0012, vermutlich Meter.

Rückgabe von GetParagraphs: Annotation.GetParagraphs liefert ein Array aus Paragraphs-Objekten. Das VBA-Hilfebeispiel weist das Ergebnis aber direkt einer Variablen vom Typ Paragraphs zu, das C#-Beispiel ebenso. Das Beispiel oben folgt den Hilfebeispielen.

Eigenschaften und Methoden

Eigenschaften 2, davon 2 beschrieben

NameBeschreibung
CountLiefert die Zahl der Absätze der Notiz.
CurrentParagraphLiest oder setzt den aktuellen Absatz, auf den sich die übrigen Befehle beziehen.

Methoden 12, davon 12 beschrieben

NameBeschreibung
GetBulletsAndNumberingLiefert, ob der aktuelle Absatz zu einer Aufzählung oder einer nummerierten Liste gehört, und wie er nummeriert ist.
GetFormattingLiefert Absatzabstand und Zeilenabstand des aktuellen Absatzes.
GetIndentationLiefert die Einzüge des aktuellen Absatzes: erste Zeile, übrige Zeilen und die Schrittweite.
GetTextLiefert den Text des aktuellen Absatzes.
GetTextSegmentCountLiefert die Zahl der Textabschnitte im aktuellen Absatz, also der Teile mit jeweils eigenem Format.
GetTextSegmentFormatLiefert das Textformat eines Textabschnitts im aktuellen Absatz.
GetTextSegmentTextLiefert den Text eines Textabschnitts im aktuellen Absatz.
SetBulletsAndNumberingMacht den aktuellen Absatz zu einem Teil einer Aufzählung oder einer nummerierten Liste oder zu einem normalen Absatz.
SetFormattingSetzt Absatzabstand und Zeilenabstand des aktuellen Absatzes.
SetIndentationSetzt die Einzüge des aktuellen Absatzes: erste Zeile, übrige Zeilen und die Schrittweite.
SetTextSegmentFormatSetzt das Textformat eines Textabschnitts im aktuellen Absatz.
UpdateParagraphÜbernimmt die Änderungen am aktuellen Absatz ins Modell.

Siehe auch

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

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