SolidWorksMakroprogrammierung

Objekt · SldWorks

Annotation-Objekt

Steht für eine Beschriftung jeder Art: Notiz, Bemaßung, Form- und Lagetoleranz, Tabelle und mehr. Name, Lage, Layer, Bezugslinien und Textformat.

Deklaration Dim x As SldWorks.Annotation · in der englischen .NET-Hilfe: IAnnotation

Beschreibung

Annotation ist die allgemeine Sicht auf alle Arten von Beschriftungen. Hier steht, was alle gemeinsam haben: Name, Lage, Sichtbarkeit, Layer und Linien, Bezugslinien, Pfeilspitzen und Textformat. An die besonderen Angaben, etwa den Text einer Notiz oder den Wert einer Bemaßung, kommst du über das Objekt dahinter: Annotation.GetSpecificAnnotation liefert es, Annotation.GetType sagt, welches es ist.

Zugriff

Beispiel

' Gibt alle Beschriftungen des aktiven Dokuments mit Art und Lage aus, hängende markiert.
' Vorbedingung: Ein Teil, eine Baugruppe oder eine Zeichnung mit Beschriftungen ist geöffnet.
' Ergebnis:     Eine Zeile je Beschriftung 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 swAnn As SldWorks.Annotation
    Dim vAnns As Variant
    Dim i As Long

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

    If swModel.GetType = swDocDRAWING Then
        Set swDraw = swModel
        Set swView = swDraw.GetFirstView            ' zuerst das Blatt selbst
        Do While Not swView Is Nothing
            Set swAnn = swView.GetFirstAnnotation3
            Do While Not swAnn Is Nothing
                Ausgeben swView.GetName2, swAnn
                Set swAnn = swAnn.GetNext3
            Loop
            Set swView = swView.GetNextView
        Loop
    Else
        vAnns = swModel.Extension.GetAnnotations
        If IsEmpty(vAnns) Then Exit Sub
        For i = 0 To UBound(vAnns)
            Ausgeben "Modell", vAnns(i)
        Next i
    End If
End Sub

Sub Ausgeben(ByVal sWo As String, ByVal swAnn As SldWorks.Annotation)    ' ByVal, weil vAnns(i) ein Variant ist
    Dim vLage As Variant
    Dim sLage As String
    vLage = swAnn.GetPosition
    If Not IsEmpty(vLage) Then sLage = Format(vLage(0) * 1000, "0.0") & " / " & Format(vLage(1) * 1000, "0.0") & " mm"
    Debug.Print sWo & ": " & swAnn.GetName & ", Art " & swAnn.GetType & ", " & sLage & _
        IIf(swAnn.IsDangling, ", HÄNGEND", "")
End Sub

Bemerkungen

Kein Umwandeln: Die besonderen Objekte wie Note oder DisplayDimension sind keine abgeleiteten Klassen von Annotation. Eine Annotation-Variable lässt sich also nicht einfach einer Note-Variable zuweisen. Den Weg gehen Annotation.GetSpecificAnnotation hin und die Methode GetAnnotation des besonderen Objekts zurück.

Koordinaten: In Zeichnungen liegt der Ursprung von Annotation.GetPosition und Annotation.SetPosition2 in der linken unteren Ecke des Blatts. Die Werte sind in Metern, auch für Beschriftungen in einer Zeichenansicht.

Nur in Zeichnungen: Layer, Farbe, Linienart und Linienstärke einer Beschriftung gibt es nur in Zeichnungen.

Bezugslinien: Bezugslinien haben nur Notizen, Form- und Lagetoleranzen, Oberflächen- und Schweißsymbole, Bezugsstellensymbole und Blöcke. Was davon welche Art von Bezugslinie kann, steht bei Annotation.SetLeader3. Bezugslinien mit mehreren Knicken liefert Annotation.GetMultiJogLeaders als MultiJogLeader.

Neu zeichnen: Die Hilfe empfiehlt nach Änderungen an der Darstellung das veraltete ModelDoc2.GraphicsRedraw2. Die Beispiele hier nehmen ModelView.GraphicsRedraw.

Die Bemaßungen liefern die Art swDisplayDimension (4), die Notizen swNote (6). Die Schleife über GetFirstView beginnt mit dem Blatt, dessen Beschriftungen Annotation.OwnerType swAnnotationOwner_DrawingSheet liefern. Mehrere Befehle dieses Objekts liefern in SOLIDWORKS 2024 einen Rückgabewert, der nicht zum Ergebnis passt, etwa Annotation.ConvertToMultiJog, Annotation.SaveStyle und Annotation.SetStyleName.

Eigenschaften und Methoden

Eigenschaften 18, davon 18 beschrieben

NameBeschreibung
AnnotationViewLiefert die Beschriftungsansicht, in der eine Beschriftung eines Teils oder einer Baugruppe liegt.
BentLeaderLengthLiest oder setzt die Länge des geknickten Teils der Bezugslinie einer Beschriftung. -1, wenn es keinen gibt.
ColorLiest oder setzt die Farbe einer Beschriftung in einer Zeichnung, abweichend von der Farbe des Layers.
FrameLineStyleLiest oder setzt die Linienart des Rahmens einer Beschriftung. Wirkt nur, wenn UseDocDispFrame False ist.
FrameThicknessLiest oder setzt die Linienstärke des Rahmens einer Beschriftung. Wirkt nur, wenn UseDocDispFrame False ist.
FrameThicknessCustomLiest oder setzt die Linienstärke des Rahmens einer Beschriftung als Zahl. Wirkt nur, wenn UseDocDispFrame False ist.
LayerLiest oder setzt den Layer, auf dem eine Beschriftung in einer Zeichnung liegt. Leer heißt: auf keinem Layer.
LayerOverrideLiest, welche Eigenschaften einer Beschriftung vom Layer abweichen (Farbe, Linienart, Stärke), oder setzt sie auf den Layer zurück.
LeaderLineStyleLiest oder setzt die Linienart der Bezugslinien einer Beschriftung. Wirkt nur, wenn UseDocDispLeader False ist.
LeaderThicknessLiest oder setzt die Linienstärke der Bezugslinien einer Beschriftung. Wirkt nur, wenn UseDocDispLeader False ist.
LeaderThicknessCustomLiest oder setzt die Linienstärke der Bezugslinien einer Beschriftung als Zahl. Wirkt nur, wenn UseDocDispLeader False ist.
OwnerLiefert, wem eine Beschriftung gehört: der Zeichenansicht, dem Blatt oder dem Modell.
OwnerTypeLiefert, wo eine Beschriftung liegt: in einer Zeichenansicht, auf dem Blatt, im Blattformat, im Teil oder in der Baugruppe.
StyleLiest oder setzt die Linienart einer Beschriftung in einer Zeichnung, abweichend vom Layer.
UseDocDispFrameLiest oder setzt, ob der Rahmen einer Beschriftung Linienart und -stärke aus dem Dokument nimmt oder eigene.
UseDocDispLeaderLiest oder setzt, ob die Bezugslinien einer Beschriftung Linienart und -stärke aus dem Dokument nehmen oder eigene.
VisibleLiest oder setzt, ob eine Beschriftung einzeln ein- oder ausgeblendet ist.
WidthLiest oder setzt die Linienstärke einer Beschriftung in einer Zeichnung, abweichend vom Layer.

Methoden 69, davon 56 beschrieben, 13 veraltet

NameBeschreibung
AddOrUpdateStyleLegt aus einer Beschriftung einen Stil an oder aktualisiert ihn.
ApplyDefaultStyleAttributesWendet die Standard-Stilattribute auf eine Beschriftung an.
CanShowInAnnotationViewLiefert, ob eine Beschriftung in einer bestimmten Beschriftungsansicht gezeigt werden kann.
CanShowInMultipleAnnotationViewsLiefert, ob eine Beschriftung in mehreren Beschriftungsansichten gezeigt werden kann.
CheckSpellingPrüft die Rechtschreibung im Text einer Beschriftung und liefert die falsch geschriebenen Wörter.
ConvertToMultiJogMacht aus einer Bezugslinie einer Notiz eine Bezugslinie mit mehreren Knicken an den angegebenen Knickpunkten.
DeleteStyleLöscht einen Stil. Beschriftungen, die ihn benutzten, behalten ihr Aussehen.
DeSelectHebt die Auswahl einer Beschriftung auf. ModelDoc2.DeSelectByID ist zuverlässiger.
GetArrowHeadCountLiefert die Anzahl der Pfeilspitzen einer Beschriftung, bei normalen Bezugslinien und bei Bezugslinien mit mehreren Knicken.
GetArrowHeadSizeAtIndexLiefert die Größe der Pfeilspitze einer Bezugslinie und ob sie aus dem Dokument kommt.
GetArrowHeadStyleAtIndexLiefert die Art der Pfeilspitze an einer Bezugslinie einer Beschriftung.
GetAttachedEntitiesveraltet ersetzt durch Annotation.GetAttachedEntities3
GetAttachedEntities2veraltet ersetzt durch Annotation.GetAttachedEntities3
GetAttachedEntities3Liefert die Elemente, an denen eine Beschriftung hängt, etwa Flächen, Kanten oder Skizzenpunkte.
GetAttachedEntityCount2veraltet ersetzt durch Annotation.GetAttachedEntityCount3
GetAttachedEntityCount3Liefert, an wie vielen Elementen eine Beschriftung hängt.
GetAttachedEntityTypesLiefert die Art jedes Elements, an dem eine Beschriftung hängt, als Werte aus swSelectType_e.
GetBentLeaderveraltet ersetzt durch Annotation.GetLeaderStyle
GetDashedLeaderLiefert, ob die Bezugslinie einer Beschriftung gestrichelt ist. Gibt es nur bei Bezugsstellensymbolen.
GetDimXpertFeatureLiefert das DimXpert-Feature, zu dem eine DimXpert-Beschriftung gehört.
GetDimXpertNameLiefert den DimXpert-Namen einer Beschriftung.
GetDisplayDataLiefert die Darstellungsdaten einer Beschriftung: die Linien, Bögen, Texte und Pfeile, aus denen sie gezeichnet wird.
GetFlipPlaneTransformLiefert die Transformation der Beschriftungsebene in umgekehrter Richtung.
GetLeaderveraltet ersetzt durch Annotation.GetLeaderStyle
GetLeaderAllAroundLiefert, ob bei einer Beschriftung das Rundum-Symbol eingeschaltet ist. Gibt es nur bei Form- und Lagetoleranzen und Schweißsymbolen.
GetLeaderCountLiefert die Anzahl der Bezugslinien einer Beschriftung. 0, wenn keine gezeigt werden.
GetLeaderPerpendicularLiefert, ob geknickte Bezugslinien einer Beschriftung senkrecht gezeichnet werden. Gibt es nur bei Form- und Lagetoleranzen.
GetLeaderPointsAtIndexLiefert die Punkte einer Bezugslinie einer Beschriftung: zwei bei gerader, drei bei geknickter Bezugslinie.
GetLeaderSideLiefert, auf welcher Seite die Bezugslinien an einer Beschriftung ansetzen: links, rechts oder automatisch.
GetLeaderStyleLiefert die Art der Bezugslinie einer Beschriftung: keine, gerade, geknickt oder unterstrichen.
GetMultiJogLeaderCountLiefert die Anzahl der Bezugslinien mit mehreren Knicken einer Beschriftung.
GetMultiJogLeadersLiefert die Bezugslinien mit mehreren Knicken einer Beschriftung.
GetNameLiefert den Namen einer Beschriftung.
GetNextveraltet ersetzt durch Annotation.GetNext3
GetNext2veraltet ersetzt durch Annotation.GetNext3
GetNext3Liefert die nächste Beschriftung, für eine Schleife über alle Beschriftungen einer Zeichenansicht oder eines Modells.
GetParagraphsLiefert die Absätze einer Notiz, mit Text, Aufzählung, Einzug und Format.
GetPlaneLiefert die Drehung der Beschriftungsebene gegenüber der X-Y-Ebene des Modells als 3×3-Matrix.
GetPMIDataLiefert die PMI-Daten einer Beschriftung aus einer importierten STEP-242-Datei.
GetPMITypeLiefert die Art der PMI-Daten einer Beschriftung aus einer STEP-242-Datei: Bemaßung, Bezug oder Form- und Lagetoleranz.
GetPositionLiefert die Lage einer Beschriftung als X, Y, Z ihres Bezugspunkts, in Zeichnungen vom Blattursprung unten links.
GetSmartArrowHeadStyleLiefert, ob eine Beschriftung die Art ihrer Pfeilspitzen automatisch wählt.
GetSpecificAnnotationLiefert das eigentliche Objekt hinter einer Beschriftung, etwa die Notiz, die Bemaßung oder die Form- und Lagetoleranz.
GetStyleNameLiefert den Namen des Stils, der auf eine Beschriftung angewendet ist.
GetTextFormatLiefert das Textformat (Schrift, Höhe, Fett usw.) eines Texts in einer Beschriftung.
GetTextFormatCountLiefert, wie viele Textformate eine Beschriftung hat. 1 bei allen außer Blöcken.
GetTypeLiefert die Art einer Beschriftung, etwa Notiz, Bemaßung, Form- und Lagetoleranz oder Tabelle.
GetUseDocTextFormatLiefert, ob ein Text einer Beschriftung das Textformat aus dem Dokument benutzt.
GetVisualPropertiesLiefert Farbe, Linienart, Linienstärke, Layer und Layer-Abweichungen einer Beschriftung in einem Array.
IsDanglingLiefert, ob eine Beschriftung hängend ist, also die Verbindung zu ihrer Geometrie verloren hat.
IsDimXpertLiefert, ob eine Beschriftung von DimXpert stammt.
LoadStyleLädt einen Stil aus einer Datei.
SaveStyleSpeichert einen Stil in eine Datei.
Selectveraltet ersetzt durch Annotation.Select3
Select2veraltet ersetzt durch Annotation.Select3
Select3Wählt eine Beschriftung aus, auf Wunsch zusätzlich zur bestehenden Auswahl und mit Markierung.
SelectByMarkveraltet ersetzt durch Annotation.Select3
SetArrowHeadSizeAtIndexSetzt die Größe der Pfeilspitze an einer Bezugslinie, oder stellt sie auf die Vorgabe des Dokuments.
SetArrowHeadStyleAtIndexSetzt die Art der Pfeilspitze an einer Bezugslinie oder an allen. Liefert einen Status statt True/False.
SetAttachedEntitiesHängt eine Beschriftung an andere Elemente, etwa an eine Fläche, Kante oder einen Eckpunkt.
SetLeaderveraltet ersetzt durch Annotation.SetLeader3
SetLeader2veraltet ersetzt durch Annotation.SetLeader3
SetLeader3Setzt die Bezugslinien einer Beschriftung: Art, Seite, automatische Pfeilspitze, senkrecht geknickt, Rundum-Symbol, gestrichelt.
SetLeaderAttachmentPointAtIndexSetzt den Anhängepunkt einer Bezugslinie einer Beschriftung.
SetNameGibt einer Beschriftung einen neuen Namen. Der Name muss eindeutig sein.
SetPositionveraltet ersetzt durch Annotation.SetPosition2
SetPosition2Verschiebt eine Beschriftung an eine neue Lage, angegeben als X, Y, Z ihres Bezugspunkts.
SetStyleNameWendet einen Stil auf eine Beschriftung an.
SetTextFormatSetzt das Textformat eines Texts in einer Beschriftung, oder stellt es auf die Vorgabe des Dokuments zurück.

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

Siehe auch

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

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