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.
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
View.GetFirstAnnotation3und dannAnnotation.GetNext3: alle Beschriftungen einer Zeichenansicht oder eines BlattsView.GetAnnotations: alle Beschriftungen einer Zeichenansicht als ArrayModelDoc2.GetFirstAnnotation2und dannAnnotation.GetNext3: Beschriftungen eines Teils oder einer BaugruppeModelDocExtension.GetAnnotations: alle Beschriftungen eines Modells als ArrayAnnotationView.GetAnnotations2: die Beschriftungen einer BeschriftungsansichtLayer.GetItems: die Beschriftungen auf einem Layer- GetAnnotation des besonderen Objekts, etwa
Note.GetAnnotation,DisplayDimension.GetAnnotation,Gtol.GetAnnotationoderTableAnnotation.GetAnnotation ModelDocExtension.InsertAnnotationFavorite: eine neu eingefügte Beschriftung aus einem Favoriten
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 SubBemerkungen
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
| Name | Beschreibung |
|---|---|
| AnnotationView | Liefert die Beschriftungsansicht, in der eine Beschriftung eines Teils oder einer Baugruppe liegt. |
| BentLeaderLength | Liest oder setzt die Länge des geknickten Teils der Bezugslinie einer Beschriftung. -1, wenn es keinen gibt. |
| Color | Liest oder setzt die Farbe einer Beschriftung in einer Zeichnung, abweichend von der Farbe des Layers. |
| FrameLineStyle | Liest oder setzt die Linienart des Rahmens einer Beschriftung. Wirkt nur, wenn UseDocDispFrame False ist. |
| FrameThickness | Liest oder setzt die Linienstärke des Rahmens einer Beschriftung. Wirkt nur, wenn UseDocDispFrame False ist. |
| FrameThicknessCustom | Liest oder setzt die Linienstärke des Rahmens einer Beschriftung als Zahl. Wirkt nur, wenn UseDocDispFrame False ist. |
| Layer | Liest oder setzt den Layer, auf dem eine Beschriftung in einer Zeichnung liegt. Leer heißt: auf keinem Layer. |
| LayerOverride | Liest, welche Eigenschaften einer Beschriftung vom Layer abweichen (Farbe, Linienart, Stärke), oder setzt sie auf den Layer zurück. |
| LeaderLineStyle | Liest oder setzt die Linienart der Bezugslinien einer Beschriftung. Wirkt nur, wenn UseDocDispLeader False ist. |
| LeaderThickness | Liest oder setzt die Linienstärke der Bezugslinien einer Beschriftung. Wirkt nur, wenn UseDocDispLeader False ist. |
| LeaderThicknessCustom | Liest oder setzt die Linienstärke der Bezugslinien einer Beschriftung als Zahl. Wirkt nur, wenn UseDocDispLeader False ist. |
| Owner | Liefert, wem eine Beschriftung gehört: der Zeichenansicht, dem Blatt oder dem Modell. |
| OwnerType | Liefert, wo eine Beschriftung liegt: in einer Zeichenansicht, auf dem Blatt, im Blattformat, im Teil oder in der Baugruppe. |
| Style | Liest oder setzt die Linienart einer Beschriftung in einer Zeichnung, abweichend vom Layer. |
| UseDocDispFrame | Liest oder setzt, ob der Rahmen einer Beschriftung Linienart und -stärke aus dem Dokument nimmt oder eigene. |
| UseDocDispLeader | Liest oder setzt, ob die Bezugslinien einer Beschriftung Linienart und -stärke aus dem Dokument nehmen oder eigene. |
| Visible | Liest oder setzt, ob eine Beschriftung einzeln ein- oder ausgeblendet ist. |
| Width | Liest oder setzt die Linienstärke einer Beschriftung in einer Zeichnung, abweichend vom Layer. |
Methoden 69, davon 56 beschrieben, 13 veraltet
| Name | Beschreibung |
|---|---|
| AddOrUpdateStyle | Legt aus einer Beschriftung einen Stil an oder aktualisiert ihn. |
| ApplyDefaultStyleAttributes | Wendet die Standard-Stilattribute auf eine Beschriftung an. |
| CanShowInAnnotationView | Liefert, ob eine Beschriftung in einer bestimmten Beschriftungsansicht gezeigt werden kann. |
| CanShowInMultipleAnnotationViews | Liefert, ob eine Beschriftung in mehreren Beschriftungsansichten gezeigt werden kann. |
| CheckSpelling | Prüft die Rechtschreibung im Text einer Beschriftung und liefert die falsch geschriebenen Wörter. |
| ConvertToMultiJog | Macht aus einer Bezugslinie einer Notiz eine Bezugslinie mit mehreren Knicken an den angegebenen Knickpunkten. |
| DeleteStyle | Löscht einen Stil. Beschriftungen, die ihn benutzten, behalten ihr Aussehen. |
| DeSelect | Hebt die Auswahl einer Beschriftung auf. ModelDoc2.DeSelectByID ist zuverlässiger. |
| GetArrowHeadCount | Liefert die Anzahl der Pfeilspitzen einer Beschriftung, bei normalen Bezugslinien und bei Bezugslinien mit mehreren Knicken. |
| GetArrowHeadSizeAtIndex | Liefert die Größe der Pfeilspitze einer Bezugslinie und ob sie aus dem Dokument kommt. |
| GetArrowHeadStyleAtIndex | Liefert die Art der Pfeilspitze an einer Bezugslinie einer Beschriftung. |
| GetAttachedEntities | veraltet ersetzt durch Annotation.GetAttachedEntities3 |
| GetAttachedEntities2 | veraltet ersetzt durch Annotation.GetAttachedEntities3 |
| GetAttachedEntities3 | Liefert die Elemente, an denen eine Beschriftung hängt, etwa Flächen, Kanten oder Skizzenpunkte. |
| GetAttachedEntityCount2 | veraltet ersetzt durch Annotation.GetAttachedEntityCount3 |
| GetAttachedEntityCount3 | Liefert, an wie vielen Elementen eine Beschriftung hängt. |
| GetAttachedEntityTypes | Liefert die Art jedes Elements, an dem eine Beschriftung hängt, als Werte aus swSelectType_e. |
| GetBentLeader | veraltet ersetzt durch Annotation.GetLeaderStyle |
| GetDashedLeader | Liefert, ob die Bezugslinie einer Beschriftung gestrichelt ist. Gibt es nur bei Bezugsstellensymbolen. |
| GetDimXpertFeature | Liefert das DimXpert-Feature, zu dem eine DimXpert-Beschriftung gehört. |
| GetDimXpertName | Liefert den DimXpert-Namen einer Beschriftung. |
| GetDisplayData | Liefert die Darstellungsdaten einer Beschriftung: die Linien, Bögen, Texte und Pfeile, aus denen sie gezeichnet wird. |
| GetFlipPlaneTransform | Liefert die Transformation der Beschriftungsebene in umgekehrter Richtung. |
| GetLeader | veraltet ersetzt durch Annotation.GetLeaderStyle |
| GetLeaderAllAround | Liefert, ob bei einer Beschriftung das Rundum-Symbol eingeschaltet ist. Gibt es nur bei Form- und Lagetoleranzen und Schweißsymbolen. |
| GetLeaderCount | Liefert die Anzahl der Bezugslinien einer Beschriftung. 0, wenn keine gezeigt werden. |
| GetLeaderPerpendicular | Liefert, ob geknickte Bezugslinien einer Beschriftung senkrecht gezeichnet werden. Gibt es nur bei Form- und Lagetoleranzen. |
| GetLeaderPointsAtIndex | Liefert die Punkte einer Bezugslinie einer Beschriftung: zwei bei gerader, drei bei geknickter Bezugslinie. |
| GetLeaderSide | Liefert, auf welcher Seite die Bezugslinien an einer Beschriftung ansetzen: links, rechts oder automatisch. |
| GetLeaderStyle | Liefert die Art der Bezugslinie einer Beschriftung: keine, gerade, geknickt oder unterstrichen. |
| GetMultiJogLeaderCount | Liefert die Anzahl der Bezugslinien mit mehreren Knicken einer Beschriftung. |
| GetMultiJogLeaders | Liefert die Bezugslinien mit mehreren Knicken einer Beschriftung. |
| GetName | Liefert den Namen einer Beschriftung. |
| GetNext | veraltet ersetzt durch Annotation.GetNext3 |
| GetNext2 | veraltet ersetzt durch Annotation.GetNext3 |
| GetNext3 | Liefert die nächste Beschriftung, für eine Schleife über alle Beschriftungen einer Zeichenansicht oder eines Modells. |
| GetParagraphs | Liefert die Absätze einer Notiz, mit Text, Aufzählung, Einzug und Format. |
| GetPlane | Liefert die Drehung der Beschriftungsebene gegenüber der X-Y-Ebene des Modells als 3×3-Matrix. |
| GetPMIData | Liefert die PMI-Daten einer Beschriftung aus einer importierten STEP-242-Datei. |
| GetPMIType | Liefert die Art der PMI-Daten einer Beschriftung aus einer STEP-242-Datei: Bemaßung, Bezug oder Form- und Lagetoleranz. |
| GetPosition | Liefert die Lage einer Beschriftung als X, Y, Z ihres Bezugspunkts, in Zeichnungen vom Blattursprung unten links. |
| GetSmartArrowHeadStyle | Liefert, ob eine Beschriftung die Art ihrer Pfeilspitzen automatisch wählt. |
| GetSpecificAnnotation | Liefert das eigentliche Objekt hinter einer Beschriftung, etwa die Notiz, die Bemaßung oder die Form- und Lagetoleranz. |
| GetStyleName | Liefert den Namen des Stils, der auf eine Beschriftung angewendet ist. |
| GetTextFormat | Liefert das Textformat (Schrift, Höhe, Fett usw.) eines Texts in einer Beschriftung. |
| GetTextFormatCount | Liefert, wie viele Textformate eine Beschriftung hat. 1 bei allen außer Blöcken. |
| GetType | Liefert die Art einer Beschriftung, etwa Notiz, Bemaßung, Form- und Lagetoleranz oder Tabelle. |
| GetUseDocTextFormat | Liefert, ob ein Text einer Beschriftung das Textformat aus dem Dokument benutzt. |
| GetVisualProperties | Liefert Farbe, Linienart, Linienstärke, Layer und Layer-Abweichungen einer Beschriftung in einem Array. |
| IsDangling | Liefert, ob eine Beschriftung hängend ist, also die Verbindung zu ihrer Geometrie verloren hat. |
| IsDimXpert | Liefert, ob eine Beschriftung von DimXpert stammt. |
| LoadStyle | Lädt einen Stil aus einer Datei. |
| SaveStyle | Speichert einen Stil in eine Datei. |
| Select | veraltet ersetzt durch Annotation.Select3 |
| Select2 | veraltet ersetzt durch Annotation.Select3 |
| Select3 | Wählt eine Beschriftung aus, auf Wunsch zusätzlich zur bestehenden Auswahl und mit Markierung. |
| SelectByMark | veraltet ersetzt durch Annotation.Select3 |
| SetArrowHeadSizeAtIndex | Setzt die Größe der Pfeilspitze an einer Bezugslinie, oder stellt sie auf die Vorgabe des Dokuments. |
| SetArrowHeadStyleAtIndex | Setzt die Art der Pfeilspitze an einer Bezugslinie oder an allen. Liefert einen Status statt True/False. |
| SetAttachedEntities | Hängt eine Beschriftung an andere Elemente, etwa an eine Fläche, Kante oder einen Eckpunkt. |
| SetLeader | veraltet ersetzt durch Annotation.SetLeader3 |
| SetLeader2 | veraltet ersetzt durch Annotation.SetLeader3 |
| SetLeader3 | Setzt die Bezugslinien einer Beschriftung: Art, Seite, automatische Pfeilspitze, senkrecht geknickt, Rundum-Symbol, gestrichelt. |
| SetLeaderAttachmentPointAtIndex | Setzt den Anhängepunkt einer Bezugslinie einer Beschriftung. |
| SetName | Gibt einer Beschriftung einen neuen Namen. Der Name muss eindeutig sein. |
| SetPosition | veraltet ersetzt durch Annotation.SetPosition2 |
| SetPosition2 | Verschiebt eine Beschriftung an eine neue Lage, angegeben als X, Y, Z ihres Bezugspunkts. |
| SetStyleName | Wendet einen Stil auf eine Beschriftung an. |
| SetTextFormat | Setzt 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.