GetTerminator Method

Description

Returns the object to which the terminal end of a dimensioning or annotation object's leader connects.

Syntax

Visual Basic
Public Sub GetTerminator( _ ByRef TerminatorObj As Object, _ ByRef x As Double, _ ByRef y As Double, _ ByRef z As Double, _ ByRef keyPoint As Boolean _ )

Parameters

TerminatorObj: Specifies the object to which the terminal end of a dimensioning or annotation object's leader connects.
x: Coordinates of the leader's terminal connect point on the TerminatorObj.
y: Coordinates of the leader's terminal connect point on the TerminatorObj.
z: Coordinates of the leader's terminal connect point on the TerminatorObj.
keyPoint: Returns True if the leader was placed with respect to the TerminatorObj. Returns False if the leader was placed with respect to a key point on the TerminatorObj.

Remarks

This method also returns the coordinates of the leader's terminal connect point and a Boolean value to indicate whether the leader was placed with respect to the object or with respect to a key point on that object.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeFrameWork.Application
    Dim objDoc As SolidEdgeDraft.DraftDocument
    Dim objSheet As SolidEdgeDraft.Sheet
    Dim objDatums As SolidEdgeFrameworkSupport.DatumFrames
    Dim objDtmFrm As SolidEdgeFrameworkSupport.DatumFrame
    Dim objLine As SolidEdgeFrameworkSupport.Line2d
    Dim objTermObject As Object
    Dim dblX As Double, dblY As Double, dblZ As Double
    Dim boolKeyPt As Boolean
    ' 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
    'Get the Active Sheet object
    Set objSheet = objDoc.ActiveSheet
    ' Create a Line object
    Set objLine = objSheet.Lines2d.AddBy2Points(x1:=0.1, y1:=0.1, x2:=0.2, y2:=0.1)
    ' Create a DatumFrames collection object
    Set objDatums = objSheet.DatumFrames
    ' Add a DatumFrame object
    Set objDtmFrm = objDatums.AddByTerminator(TerminatorObject:=objLine, _
                                              x1:=0.15, y1:=0.1, z1:=0, keyPoint1:=False)
    objDtmFrm.Datum = "Test"

    ' Get the Terminator object
    Call objDtmFrm.GetTerminator(TerminatorObj:=objTermObject, _
                                 x:=dblX, y:=dblY, z:=dblZ, Keypoint:=boolKeyPt)
    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objSheet = Nothing
    Set objDatums = Nothing
    Set objDtmFrm = Nothing
    Set objLine = Nothing
End Sub