SolidWorksMakroprogrammierung

Objekt · SldWorks

Callout-Objekt

Eine Beschriftung im Grafikbereich mit einer oder mehreren Zeilen, je Zeile mit Bezeichnung und einem Wert, den der Benutzer ändern kann.

Deklaration Dim x As SldWorks.Callout · in der englischen .NET-Hilfe: ICallout

Beschreibung

Callout gibt Zugriff auf Callouts mit einer oder mehreren Zeilen. Ein Callout ist eine Beschriftung im Grafikbereich. Jede Zeile hat eine Bezeichnung und einen Wert, den der Benutzer ändern kann. Eine Bezugslinie zeigt auf einen Zielpunkt. Ein Callout hängt entweder an einer Auswahl oder steht unabhängig davon im Modell.

Zugriff

Beispiel

' Zeigt im aktiven Modell einen Callout mit zwei Zeilen an, der auf den Ursprung zeigt.
' Vorbedingung: Ein Teil oder eine Baugruppe ist offen. Im VBA-Editor ist unter Extras › Verweise
'               „SOLIDWORKS <Version> exposed type libraries for add-in use“ angehakt.
'               Im Makro gibt es das Klassenmodul CalloutHandler (Code darunter).
' Ergebnis:     Der Callout steht im Grafikbereich. Ändert der Benutzer den Wert der zweiten Zeile,
'               steht der neue Text im Direktfenster.
Option Explicit

Dim swCallout As SldWorks.Callout               ' auf Modulebene, wie im Hilfebeispiel
Dim oHandler As New CalloutHandler

Sub main()
    Dim swApp As SldWorks.SldWorks
    Dim swModel As SldWorks.ModelDoc2
    Dim swMathUtil As SldWorks.MathUtility
    Dim swPunkt As SldWorks.MathPoint
    Dim dPunkt(2) As Double

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

    Set swCallout = swModel.Extension.CreateCallout(2, oHandler)
    If swCallout Is Nothing Then Exit Sub
    swCallout.Label2(0) = "Projekt"
    swCallout.Value(0) = "4711"
    swCallout.ValueInactive(0) = True               ' nicht änderbar
    swCallout.Label2(1) = "Bemerkung"
    swCallout.Value(1) = "bitte prüfen"             ' änderbar
    swCallout.TextBox = True                        ' vor dem Anzeigen setzen
    swCallout.SetLeader True, False
    swCallout.SetTargetPoint 0, 0, 0, 0             ' Zielpunkt am Ursprung
    swCallout.SetTargetPoint 1, 0, 0, 0

    Set swMathUtil = swApp.GetMathUtility
    dPunkt(0) = 0.05: dPunkt(1) = 0.05: dPunkt(2) = 0
    Set swPunkt = swMathUtil.CreatePoint(dPunkt)
    swCallout.Position = swPunkt                    ' ohne Set, wie im Hilfebeispiel
    swCallout.Display True
End Sub
Option Explicit

Implements SwCalloutHandler

Private Function SwCalloutHandler_OnStringValueChanged(ByVal pManipulator As Object, _
        ByVal RowID As Long, ByVal Text As String) As Boolean
    Debug.Print "Zeile " & RowID & ": " & Text
    SwCalloutHandler_OnStringValueChanged = True    ' neuen Text übernehmen
End Function

Bemerkungen

Handler: Zum Anlegen brauchst du ein Objekt, das die Schnittstelle SwCalloutHandler umsetzt. In VBA ist das ein Klassenmodul mit Implements SwCalloutHandler. Dafür hakst du im VBA-Editor unter Extras › Verweise „SOLIDWORKS <Version> exposed type libraries for add-in use“ an. Die Schnittstelle hat nur die Funktion OnStringValueChanged. SOLIDWORKS ruft sie auf, wenn der Benutzer den Text einer Zeile ändert. Gibt sie True zurück, gilt der neue Text, bei False bleibt der alte.

Mit oder ohne Auswahl: ModelDocExtension.CreateCallout legt einen Callout unabhängig von einer Auswahl an, angezeigt wird er mit Callout.Display. SelectionMgr.CreateCallout2 legt einen Callout für eine Auswahl an. Das Hilfebeispiel „Create Multi-row Callouts“ hängt ihn an, indem es ihn beim Auswählen an ModelDocExtension.SelectByID2 übergibt. An ein schon ausgewähltes Objekt hängst du ihn mit SelectionMgr.SetCallout. Callout.SkipColon und Callout.IgnoreValue gelten nur für Callouts ohne Auswahl.

Zeilen: Die Zahl der Zeilen legst du beim Anlegen fest. Sie zählen ab 0. Die Hilfebeispiele „Create Multi-row Callouts“ und „Create a Callout in a Model View“ zählen ab 0. Das Beispiel „Create a Callout Independent of a Selection“ legt 2 Zeilen an und nutzt die Nummern 0, 1 und 2.

Lebensdauer: Das Beispiel deklariert Callout und Handler wie das Hilfebeispiel auf Modulebene, damit beide nach dem Ende von main weiterleben. Ob der Callout sonst verschwindet, sagt die Hilfe nicht.

Farben: Callout.TextColor und Callout.OpaqueColor nehmen nur Systemfarben, also Werte swSystemColors… aus swUserPreferenceIntegerValue_e.

Eigenschaften und Methoden

Eigenschaften 15, davon 15 beschrieben

NameBeschreibung
EnablePushPinLiest oder setzt, ob die Pinnadel (pushpin) des Callouts eingeschaltet ist.
FontSizeLiest oder setzt die Schriftgröße des Callouts.
IgnoreValueLiest oder setzt, ob der Callout den Wert einer Zeile weglässt, sodass kein leerer Platz bleibt.
LabelDie alte Hilfe beschreibt sie als Text des Callouts. Die Hilfe zu veralteten Befehlen nennt Label2 als Ersatz.
Label2Liest oder setzt die Bezeichnung in einer Zeile des Callouts, also den Text vor dem Wert.
MultipleLeadersLiest oder setzt, ob der Callout mehrere Bezugslinien zeigt.
OpaqueColorLiest oder setzt die Hintergrundfarbe der Bezeichnungen im Callout. Erlaubt sind nur Systemfarben.
PositionLiest oder setzt die Lage des Callouts als Punkt (MathPoint).
SkipColonLiest oder setzt, ob hinter der Bezeichnung einer Zeile der Doppelpunkt wegfällt.
TargetStyleLiest oder setzt die Form am Zielpunkt des Callouts, etwa Pfeil, Kreis oder keine.
TextBoxLiest oder setzt, ob der Text des Callouts in einem Rahmen steht.
TextColorLiest oder setzt die Textfarbe einer Zeile des Callouts. Erlaubt sind nur Systemfarben.
TextFormatLiest oder setzt das Textformat des Callouts, etwa Schriftart, Schrifthöhe und Schriftschnitt.
ValueLiest oder setzt den Wert in einer Zeile des Callouts, also den Text hinter der Bezeichnung.
ValueInactiveLiest oder setzt, ob der Benutzer den Wert in einer Zeile des Callouts nicht ändern kann.

Methoden 6, davon 5 beschrieben, 1 veraltet

NameBeschreibung
DisplayZeigt einen Callout an, der unabhängig von einer Auswahl ist, oder blendet ihn aus.
GetLeaderLiefert, ob der Callout eine Bezugslinie zeigt und ob mehrere.
GetTargetPointLiefert den Zielpunkt einer Zeile des Callouts, also den Punkt, auf den die Bezugslinie zeigt.
SetLeaderLegt fest, ob der Callout eine Bezugslinie zeigt und ob mehrere.
SetTargetPointSetzt den Zielpunkt einer Zeile des Callouts, also den Punkt, auf den die Bezugslinie zeigt.
UpdatePositionveraltet ersetzt durch Callout.Position

Siehe auch

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

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