SolidWorksMakroprogrammierung

Objekt · SldWorks

Note-Objekt

Steht für eine Notiz: Text, Ballon, Stücklisten-Ballon, Hyperlink, Wasserzeichen und die Geometrie, aus der sie gezeichnet wird.

Deklaration Dim x As SldWorks.Note · in der englischen .NET-Hilfe: INote

Beschreibung

Eine Notiz ist eine Beschriftung mit Text, in Zeichnungen, Teilen und Baugruppen. Auch Ballons, Stücklisten-Ballons und Biegelinien-Notizen von Blechteilen sind Notizen. Note enthält, was nur Notizen haben: Text, Ballon, Hyperlink und die Linien, aus denen sie gezeichnet werden. Lage, Layer, Sichtbarkeit und Textformat stehen bei der zugehörigen Annotation, die du mit Note.GetAnnotation bekommst.

Zugriff

Beispiel

' Listet alle Notizen der aktiven Zeichnung auf, mit Art und Lage.
' Vorbedingung: Eine Zeichnung ist geöffnet.
' Ergebnis:     Eine Zeile je Notiz im Direktfenster (Strg+G).
Option Explicit

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swDraw As SldWorks.DrawingDoc
    Dim swView As SldWorks.View
    Dim swNote As SldWorks.Note
    Dim vPunkt As Variant
    Dim sArt As String

    Set swApp = Application.SldWorks
    Set swModel = swApp.ActiveDoc
    If swModel Is Nothing Then Exit Sub
    If swModel.GetType <> swDocDRAWING Then Exit Sub
    Set swDraw = swModel

    Set swView = swDraw.GetFirstView            ' zuerst das Blatt selbst
    Do While Not swView Is Nothing
        Set swNote = swView.GetFirstNote2
        Do While Not swNote Is Nothing
            If swNote.IsBomBalloon Then
                sArt = "Stücklisten-Ballon " & swNote.GetBomBalloonText(True)
            ElseIf swNote.HasBalloon Then
                sArt = "Ballon"
            ElseIf swNote.GetHyperlinkText <> "" Then
                sArt = "Hyperlink auf " & swNote.GetHyperlinkText
            Else
                sArt = "Notiz"
            End If
            vPunkt = swNote.GetTextPoint2
            If Not IsEmpty(vPunkt) Then sArt = sArt & " bei " & Format(vPunkt(0) * 1000, "0") & _
                " / " & Format(vPunkt(1) * 1000, "0") & " mm"
            Debug.Print swView.GetName2 & ": " & sArt & ", """ & swNote.GetText & """"
            Set swNote = swNote.GetNext
        Loop
        Set swView = swView.GetNextView
    Loop
End Sub

Bemerkungen

Variablenname: swNote ist auch der Name einer Konstanten aus swAnnotationType_e. Brauchst du im selben Makro beides, etwa für Annotation.GetType = swNote, nenn die Variable anders, zum Beispiel swNoteObj.

Koordinaten: Die Punkte der Geometrie-Befehle sind im Dokumentraum: in Zeichnungen vom Ursprung des Blatts unten links, in Teilen und Baugruppen vom Ursprung des Modells. Eine Einheit nennt die Hilfe meist nicht. Ausdrücklich in Metern sind nur Note.SetHeight und Note.GetTextHeightAtIndex.

Index der Texte: Die Hilfe zählt die GetText…AtIndex-Befehle uneinheitlich: Note.GetTextAtIndex, Note.GetTextAngleAtIndex, Note.GetTextPositionAtIndex, Note.GetTextRefPositionAtIndex und Note.GetTextLineSpacingAtIndex ab 1, Note.GetTextFontAtIndex, Note.GetTextHeightAtIndex und Note.GetTextInvertAtIndex ab 0.

Zusammengesetzte Notizen: Sie lassen sich in SOLIDWORKS nicht mehr anlegen. Befehle dafür sind nur für alte Dateien gedacht. Ersatz sind Blöcke (SketchBlockDefinition, SketchBlockInstance).

View.GetFirstNote2 gibt es erst seit SOLIDWORKS 2025 SP01. In älteren Versionen bricht das Beispiel damit mit Laufzeitfehler 438 ab, dort nimmst du den Vorgänger View.GetFirstNote.

Eigenschaften und Methoden

Eigenschaften 17, davon 17 beschrieben

NameBeschreibung
AllUpperCaseLiest oder setzt, ob der Text einer Notiz in Großbuchstaben angezeigt wird.
AngleLiest oder setzt den Drehwinkel einer Notiz, im Bogenmaß.
BehindSheetLiest oder setzt, ob eine Notiz im Blattformat einer Zeichnung hinter dem Blatt liegt, etwa als Wasserzeichen.
HasMultipleFontsLiefert, ob eine Notiz mehrere Schriften enthält, also eingebettete Formatierungen im Text.
IncludeDimPrefixSuffixToleranceLiest oder setzt, ob eine Notiz mit verknüpfter Bemaßung auch deren Präfix, Suffix und Toleranz zeigt.
IsBendLineNoteLiefert, ob eine Notiz eine Biegelinien-Notiz eines Blechteils ist.
LockPositionLiest oder setzt, ob eine Notiz verankert ist, ihre Lage also festgehalten wird.
PromptTextLiest oder setzt den Text der Eingabeaufforderung einer Notiz.
PropertyLinkedTextLiest oder setzt den Text einer Notiz mit ihren Verknüpfungen, etwa $PRPVIEW:"SW-Long Date" statt des Datums.
ReadOnlyLiest oder setzt, ob eine Notiz schreibgeschützt ist.
TagNameLiest oder setzt den Tag-Namen einer Notiz, etwa einer Attribut-Notiz in einem Block.
TextRightToLeftLiest oder setzt, ob eine Notiz von rechts nach links geschrieben wird. Nur bei Hebräisch als Systemsprache.
ToBoundingBoxLiest oder setzt die Option „Bis zum Begrenzungsrahmen“ für die Bezugslinien einer Notiz.
VisibleLiest oder setzt, ob eine Notiz beim Erstellen eines Blocks im Block sichtbar ist.
WatermarkBehindGeometryLiest oder setzt, ob ein Wasserzeichen in einem Teil oder einer Baugruppe hinter der Geometrie liegt.
WatermarkNoteLiest oder setzt, ob eine Notiz in einem Teil oder einer Baugruppe ein Wasserzeichen ist.
WatermarkTransparencyLevelLiest oder setzt, wie durchsichtig ein Wasserzeichen ist, von 0 bis 1.

Methoden 87, davon 64 beschrieben, 23 veraltet

NameBeschreibung
AddTextveraltet
BeginSketchEditveraltet
EndSketchEditveraltet
GetAnnotationLiefert die Beschriftung (Annotation) zu einer Notiz, mit Lage, Layer, Bezugslinien und Textformat.
GetArcAtIndexLiefert einen Bogen, aus dem eine Notiz gezeichnet wird: Linientyp, Anfang, Ende, Mitte und Drehsinn.
GetArcCountLiefert, aus wie vielen Bögen eine Notiz gezeichnet wird.
GetArrowHeadAtIndexLiefert Lage, Richtung, Maße und Art einer Pfeilspitze am Ende einer Bezugslinie der Notiz.
GetArrowHeadCountLiefert die Anzahl der Pfeilspitzen einer Notiz.
GetArrowHeadInfoLiefert Maße und Art der Pfeilspitze am Ende der Bezugslinie einer Notiz.
GetAttachPosLiefert den Anhängepunkt einer Notiz, also wo ihre Bezugslinie am Modell ansetzt.
GetBalloonInfoLiefert Mittelpunkt, einen Randpunkt und Radius des Ballons um den Text einer Notiz.
GetBalloonOptionsLiefert die Einstellungen einer Positionsnummer, etwa Form, Größe, Text und Menge.
GetBalloonPaddingLiefert den Innenabstand eines Ballons. Gilt nur bei der engsten Ballongröße.
GetBalloonSizeLiefert die Größe eines Ballons: für wie viele Zeichen, eng anliegend oder eigene Größe.
GetBalloonStackLiefert den Ballonstapel, zu dem ein Ballon gehört, oder Nothing.
GetBalloonStyleLiefert die Form eines Ballons, etwa Kreis, Dreieck oder Sechseck.
GetBendLineValuesveraltet ersetzt durch Note.GetBendLineValues2
GetBendLineValues2Liefert die Werte einer Biegelinien-Notiz: Richtung, Winkel, Radius und die Punkte der Biegelinie.
GetBomBalloonTextLiefert den oberen oder unteren Text eines Stücklisten-Ballons.
GetBomBalloonTextStyleLiefert, woher der obere oder untere Text eines Stücklisten-Ballons kommt: Positionsnummer, Menge, Eigenschaft oder eigener Text.
GetCompoundTextAtIndexveraltet
GetCompoundTextCountveraltet
GetExtentLiefert den umschließenden Rahmen einer Notiz in Blattkoordinaten: untere linke und obere rechte Ecke.
GetExtentAtIndexveraltet
GetFontInfoLiefert zurzeit nur den Linientyp einer Notiz, keine Schriftangaben.
GetHeightLiefert die Texthöhe einer Notiz.
GetHeightAtIndexveraltet
GetHeightInPointsLiefert die Texthöhe einer Notiz in Punkt, etwa 8, 10 oder 12.
GetHyperlinkTextLiefert den Hyperlink einer Notiz, eine Internetadresse oder einen Dateipfad.
GetLeaderAtIndexLiefert die Punkte einer Bezugslinie einer Notiz: keine, zwei bei gerader, drei bei geknickter Bezugslinie.
GetLeaderCountLiefert die Anzahl der Bezugslinien einer Notiz.
GetLeaderInfoLiefert die Punkte der Bezugslinie einer Notiz, ohne Index.
GetLeaderNumPointsAtLiefert, aus wie vielen Punkten eine Bezugslinie einer Notiz besteht.
GetLineAtIndexLiefert eine Linie, aus der eine Notiz gezeichnet wird: Linientyp, Anfangs- und Endpunkt.
GetLineCountLiefert, aus wie vielen Linienstücken eine Notiz gezeichnet wird.
GetNameLiefert den Namen einer Notiz. Leer, wenn die Notiz zu einem Block gehört.
GetNextLiefert die nächste Notiz einer Zeichenansicht, für eine Schleife über alle Notizen.
GetSketchveraltet
GetTextLiefert den Text einer Notiz, mit den Werten verknüpfter Eigenschaften und Bemaßungen.
GetTextAngleAtIndexLiefert den Winkel eines einzelnen Texts in einer Notiz, im Bogenmaß gegen den Uhrzeigersinn von der X-Achse.
GetTextAtIndexLiefert einen einzelnen Text einer Notiz, die aus mehreren Texten besteht.
GetTextCountLiefert, aus wie vielen einzelnen Texten eine Notiz besteht.
GetTextFontAtIndexLiefert den Namen der Schrift eines einzelnen Texts in einer Notiz.
GetTextFormatveraltet ersetzt durch Annotation.GetTextFormat
GetTextFormatAtIndexveraltet ersetzt durch Annotation.GetTextFormat
GetTextHeightAtIndexLiefert die Höhe eines einzelnen Texts in einer Notiz, in Metern.
GetTextInvertAtIndexLiefert, ob ein einzelner Text einer Notiz an der X-Achse gespiegelt ist.
GetTextJustificationLiefert die waagrechte Ausrichtung des Texts einer Notiz: links, zentriert oder rechts.
GetTextJustificationAtIndexveraltet
GetTextLineSpacingAtIndexLiefert den Zeilenabstand eines einzelnen Texts in einer Notiz.
GetTextOffsetAtIndexveraltet
GetTextPointveraltet ersetzt durch Note.GetTextPoint2
GetTextPoint2Liefert den Bezugspunkt einer Notiz: die linke obere Ecke ihres Textrahmens.
GetTextPositionAtIndexLiefert die Lage eines einzelnen Texts einer Notiz im Dokument.
GetTextRefPositionAtIndexLiefert, auf welchen Punkt sich die Lage eines Texts in einer Notiz bezieht, etwa oben links oder Mitte.
GetTextTokensOhne Beschreibung in der Hilfe. Dem Namen nach: liefert die Textteile einer Notiz mit Lage, Breite und Höhe.
GetTextVerticalJustificationLiefert die senkrechte Ausrichtung des Texts einer Notiz: oben, Mitte oder unten.
GetTriangleAtIndexLiefert ein Dreieck, aus dem eine Notiz gezeichnet wird, etwa eine Pfeilspitze: drei Eckpunkte, gefüllt, Linientyp.
GetTriangleCountLiefert, aus wie vielen Dreiecken eine Notiz gezeichnet wird.
GetUpperRightLiefert den rechten oberen Punkt des Texts einer Notiz.
GetUseDocTextFormatveraltet ersetzt durch Annotation.GetUseDocTextFormat
HasBalloonLiefert, ob eine Notiz einen Ballon hat.
HasExtraLeaderLiefert, ob die Bezugslinie einer Notiz geknickt ist.
IsAttachedLiefert, ob eine Notiz mit einer Bezugslinie angehängt ist.
IsAttributeveraltet
IsBomBalloonLiefert, ob eine Notiz ein Stücklisten-Ballon ist.
IsCompoundNoteveraltet
IsStackedBalloonLiefert, ob eine Notiz zu einem Ballonstapel gehört.
IsStackedBalloonMasterLiefert, ob eine Notiz die Haupt-Notiz eines Ballonstapels ist.
MakeStackedBalloonMacht aus einem Ballon einen Ballonstapel.
SetBalloonSetzt Form und Größe des Ballons einer Notiz, oder entfernt ihn.
SetBalloonPaddingSetzt den Innenabstand eines Ballons. Gilt nur bei der engsten Ballongröße.
SetBomBalloonTextSetzt oberen und unteren Text eines Stücklisten-Ballons, als Positionsnummer, Menge, Eigenschaft oder eigenen Text.
SetHeightSetzt die Texthöhe einer Notiz in Metern.
SetHeightInPointsSetzt die Texthöhe einer Notiz in Punkt, etwa 8, 10 oder 12.
SetHyperlinkTextSetzt einen Hyperlink in eine Notiz, auf eine Internetadresse oder eine Datei.
SetNameGibt einer Notiz einen neuen Namen.
SetTextErsetzt den Text einer Notiz.
SetTextAtIndexveraltet
SetTextFormatveraltet ersetzt durch Annotation.SetTextFormat
SetTextFormatAtIndexveraltet ersetzt durch Annotation.SetTextFormat
SetTextJustificationSetzt die waagrechte Ausrichtung des Texts einer Notiz: links, zentriert oder rechts.
SetTextJustificationAtIndexveraltet
SetTextOffsetAtIndexveraltet
SetTextPointVerschiebt eine Notiz: setzt ihren Ursprung, die linke obere Ecke des Textrahmens.
SetTextVerticalJustificationSetzt die senkrechte Ausrichtung des Texts einer Notiz: oben, Mitte oder unten.
SetZeroLengthLeaderveraltet

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

Siehe auch

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

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