AddByTerminator Method

Description

Creates a Leader or annotation object with a Leader.

Syntax

Visual Basic
Public Function AddByTerminator( _ ByVal TerminatorObject As Object, _ ByVal x1 As Double, _ ByVal y1 As Double, _ ByVal z1 As Double, _ ByVal keyPoint1 As Boolean _ ) As Balloon

Parameters

TerminatorObject: Specifies the object to which the terminal end of the leader connects.
x1: Specifies the coordinates of the leader's start locate point. This point is used as a proximity point while calculating the key point. The z1 argument applies only to 3-D objects.
y1: Specifies the coordinates of the leader's start locate point. This point is used as a proximity point while calculating the key point. The z1 argument applies only to 3-D objects.
z1: Specifies the coordinates of the leader's start locate point. This point is used as a proximity point while calculating the key point. The z1 argument applies only to 3-D objects.
keyPoint1: Specifies whether the object or a key point of the TerminatorObject is to be considered. If KeyPoint1 is True, the leader's terminal end is placed with respect to the TerminatorObject; if KeyPoint1 is False, the nearest key point on that object is selected.

Remarks

To create the annotation object with this method, specify the object to which the leader connects. As a result of this method, the annotation object is automatically positioned with respect to the object to which the leader connects.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeFramework.Application
    Dim objDoc As SolidEdgeDraft.DraftDocument
    Dim objSheet As SolidEdgeDraft.Sheet
    Dim objCircle As SolidEdgeFrameworkSupport.Circle2d
    Dim objBalloons As SolidEdgeFrameworkSupport.Balloons
    ' Report errors
    Const PI = 3.14159265358979
    ' Create/get the application with specific settings
    On Error Resume Next
    Set objApp = GetObject(, "SolidEdge.Application")
    If Err Then
        Err.Clear
        Set objApp = CreateObject("SolidEdge.Application")
        Set objDoc = objApp.Documents.Add("SolidEdge.DraftDocument")
        objApp.Visible = True
    Else
        Set objDoc = objApp.ActiveDocument
    End If
    ' getting the Active Sheet object
    Set objSheet = objDoc.ActiveSheet
    ' getting the Balloons collection object on the active sheet
    Set objBalloons = objSheet.Balloons
    ' drawing a circle on the sheet
    Set objCircle = objSheet.Circles2d.AddByCenterRadius(x:=0.25, y:=0.25, Radius:=0.05)
    ' adding two balloons on the active sheet
    Call objBalloons.AddByTerminator(TerminatorObject:=objCircle, x1:=0.75, y1:=0.05, z1:=0, keyPoint1:=True)
    Call objBalloons.AddByTerminator(TerminatorObject:=objCircle, x1:=0.75, y1:=0.015, z1:=0, keyPoint1:=False)
    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objSheet = Nothing
    Set objCircle = Nothing
    Set objBalloons = Nothing
End Sub